Merge pull request #3450 from hashicorp/f-release-guide

Document release procedure
This commit is contained in:
Alex Dadgar 2017-10-26 12:34:51 -07:00 committed by GitHub
commit 5487dc5525
2 changed files with 33 additions and 1 deletions

View file

@ -204,9 +204,13 @@ dev: ## Build for the current development platform
@cp $(PROJECT_ROOT)/$(DEV_TARGET) $(PROJECT_ROOT)/bin/
@cp $(PROJECT_ROOT)/$(DEV_TARGET) $(GOPATH)/bin
.PHONY: prerelease
prerelease: GO_TAGS="ui"
prerelease: check generate ember-dist static-assets ## Generate all the static assets for a Nomad release
.PHONY: release
release: GO_TAGS="ui"
release: clean ember-dist static-assets $(foreach t,$(ALL_TARGETS),pkg/$(t).zip) ## Build all release packages which can be built on this platform.
release: clean $(foreach t,$(ALL_TARGETS),pkg/$(t).zip) ## Build all release packages which can be built on this platform.
@echo "==> Results:"
@tree --dirsfirst $(PROJECT_ROOT)/pkg

28
dev/guides/releasing.md Normal file
View file

@ -0,0 +1,28 @@
This guide provides step by step guidance for cutting a new release of Nomad.
1. Bump the version in `version/version.go`
2. Run `make prerelease`
3. Commit any changed, generated files.
4. On the Linux Vagrant run `make release`
5. `mv pkg/ pkg2/`. We move the compiled packages such that when we run step 6,
the binaries are deleted.
6. On a Mac, run `make release`
7. `mv pkg2/* pkg/`. This moves all the binaries into the same folder and thus
we are ready for releasing.
8. Ensure you have the hc-release environment variables set for being able to
read/write to S3. This can be retrieved from 1password.
9. `./scripts/dist.sh <version>`. Formating of <version> is 0.x.x(-|rcx|betaX)
# Only on final releases
1. Add the new version to checkpoint.
# Modifying the website
Assuming master is the branch you want the website to reflect
1. On master, bump the version in `website/config.rb`
2. Delete the remote stable-website branch (`git push -d origin stable-website`)
3. Create the new stable webiste, `git checkout -b stable-website`
4. `git push origin stable-website`
5. In Slack run, `hashibot deploy nomad`