Skip to content

Commit 59cb47d

Browse files
committed
Added MAINTAINERS instructions
1 parent d917c62 commit 59cb47d

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

MAINTAINERS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Maintainer Instructions
2+
3+
## Running tests
4+
5+
A subset of all tests are frequently run in Travis.
6+
7+
To run the entire test set, run:
8+
9+
```bash
10+
make run-tests
11+
```
12+
13+
## Building a release
14+
15+
To make a release you must have:
16+
17+
- A github access token in `~/.arangodb/github-token` that has read/write access
18+
for this repository.
19+
- Push permission for the current docker account (`docker login <your-docker-hub-account>`)
20+
for the `arangodb` docker hub namespace.
21+
- The latest checked out `master` branch of this repository.
22+
23+
```bash
24+
make release-patch
25+
# or
26+
make release-minor
27+
# or
28+
make release-major
29+
```
30+
31+
If successful, a new version will be:
32+
33+
- Build for Mac, Windows & Linux (all amd64).
34+
- Tagged in github
35+
- Uploaded as github release
36+
- Pushed as docker image to docker hub
37+
- `./VERSION` will be updated to a `+git` version (after the release process)
38+
39+
If the release process fails, it may leave:
40+
41+
- `./VERSION` uncommitted. To resolve, checkout `master` or edit it to
42+
the original value and commit to master.
43+
- A git tag named `<major>.<minor>.<patch>` in your repository.
44+
To resolve remove it using `git tag -d ...`.
45+
- A git tag named `<major>.<minor>.<patch>` in this repository in github.
46+
To resolve remove it manually.

0 commit comments

Comments
 (0)