Skip to content

Commit 0e5f5b5

Browse files
authored
Merge pull request #191 from arangodb-helper/docs/maintainers.md
Added MAINTAINERS instructions
2 parents 5d62b57 + 2c7fd26 commit 0e5f5b5

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

MAINTAINERS.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
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+
## Preparing a release
14+
15+
To prepare for a release, do the following:
16+
17+
- Update CHANGELOG.md. Update the first title (master -> new version). Commit it.
18+
- Make sure all tests are OK.
19+
20+
## Building a release
21+
22+
To make a release you must have:
23+
24+
- A github access token in `~/.arangodb/github-token` that has read/write access
25+
for this repository.
26+
- Push permission for the current docker account (`docker login <your-docker-hub-account>`)
27+
for the `arangodb` docker hub namespace.
28+
- The latest checked out `master` branch of this repository.
29+
30+
```bash
31+
make release-patch
32+
# or
33+
make release-minor
34+
# or
35+
make release-major
36+
```
37+
38+
If successful, a new version will be:
39+
40+
- Build for Mac, Windows & Linux (all amd64).
41+
- Tagged in github
42+
- Uploaded as github release
43+
- Pushed as docker image to docker hub
44+
- `./VERSION` will be updated to a `+git` version (after the release process)
45+
46+
If the release process fails, it may leave:
47+
48+
- `./VERSION` uncommitted. To resolve, checkout `master` or edit it to
49+
the original value and commit to master.
50+
- A git tag named `<major>.<minor>.<patch>` in your repository.
51+
To resolve remove it using `git tag -d ...`.
52+
- A git tag named `<major>.<minor>.<patch>` in this repository in github.
53+
To resolve remove it manually.
54+
55+
## Completing after a release
56+
57+
After the release has been build (which includes publication) the following
58+
has to be done:
59+
60+
- Update CHANGELOG.md. Add a new first title (released version -> master). Commit it.

0 commit comments

Comments
 (0)