Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.48 KB

MAINTAINERS.md

File metadata and controls

35 lines (27 loc) · 1.48 KB
Raw

Maintainer Instructions

  • Always preserve backward compatibility
  • Build using make clean && make
  • After merging PR, always run make changelog and commit changes
  • Set ArangoDB docker container (used for testing) using export ARANGODB=<image-name>
  • Run tests using:
    • make run-tests-single
    • make run-tests-resilientsingle
    • make run-tests-cluster.
  • The test can be launched with the flag RACE=on which means that test will be performed with the race detector, e.g:
    • RACE=on make run-tests-single
  • Always create changes in a PR

Change Golang version

  • Edit the .circleci/config.yml file and change ALL occurrences of gcr.io/gcr-for-testing/golang to the appropriate version.
  • Edit the Makefile and change the GOVERSION to the appropriate version.
  • For minor Golang version update, bump the Go version in go.mod and v2/go.mod and run go mod tidy.

Debugging with DLV

To attach DLV debugger run tests with DEBUG=true flag e.g.:

DEBUG=true TESTOPTIONS="-test.run TestResponseHeader -test.v" make run-tests-single-json-with-auth

Release Instructions

  1. Update CHANGELOG.md
  2. Make sure that GitHub access token exist in ~/.arangodb/github-token and has read/write access for this repo.
  3. Run make release-patch|minor|major to create a release.
    • To release v2 version, use make release-v2-patch|minor|major.
  4. Go To GitHub and fill the description with the content of CHANGELOG.md