Skip to content

Commit

Permalink
Update build & release documentation
Browse files Browse the repository at this point in the history
  -Delete old release script
  -Add release process
  -Update manual build steps for development
  • Loading branch information
sargun committed Sep 14, 2016
1 parent 1810c09 commit bea3bf8
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 17 deletions.
11 changes: 6 additions & 5 deletions README.md
Expand Up @@ -18,12 +18,13 @@ the same stability and compatibility guarantees as releases.
All branches and pull requests are tested by [Circle-CI](https://circleci.com/gh/mesosphere/mesos-dns), which also
outputs artifacts for Mac OS X, Windows, and Linux via cross-compilation.

You will need [Go](https://golang.org/) *1.5* or later to build the project.
All dependencies are vendored using `Godeps`. You must first install it in order to build from source.
You will need [Go](https://golang.org/) *1.6* or later to build the project.
All dependencies are vendored using `Govendor`. You must first install it in order to build from source.

```shell
$ go get github.com/tools/godep
$ godep go build ./...
$ go get github.com/kardianos/govendor
$ govendor sync
$ go build ./...
```

### Building for release
Expand Down Expand Up @@ -53,7 +54,7 @@ There are only very few users with access to the private key, and they also have

## Testing
```shell
$ godep go test -race ./...
$ go test -race ./...
```

## Documentation
Expand Down
16 changes: 16 additions & 0 deletions release.md
@@ -0,0 +1,16 @@
# How to Release
We release Mesos-DNS once every 3-4 months or so. We try to release several release candidates prior to a release.

## Releasing an RC
1. Tag a commit `git tag v0.5.3-rc1` (example)
2. git push --tags
3. Rebuild it in Circle-ci without cache
4. Upload artifacts from Circle-ci to Github

## Releasing
1. Cut a branch like release-v0.5.3
2. Populate CHANGELOG as to differences from the last release.
3. Commit this as "Releasing v0.5.3"
4. Tag this specific commit as `v0.5.3`
5. `git push --tags`
6. Upload artifacts from Circle-CI to Github
12 changes: 0 additions & 12 deletions release.sh

This file was deleted.

0 comments on commit bea3bf8

Please sign in to comment.