Arsharth/dex
1
0
Fork 0
forked from mystiq/dex
Code Issues Pull requests Packages Projects Releases Wiki Activity

Documentation: clean up release documentation

Browse source
This commit is contained in:
Eric Chiang 2016-06-30 15:31:44 -07:00
parent 7bc69644ec
commit b263976c08
1 changed files with 30 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
Documentation/releases.md
View file

@ -1,25 +1,37 @@
## Making a dex Release # Making a dex Release
1. Make sure you've [uploaded your GPG key](https://github.com/settings/keys). Make sure you've [uploaded your GPG key](https://github.com/settings/keys) and
configured git to [use that signing key](
https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) either globally or
for the Dex repo. Note that the email the key is issued for must be the email
you use for git.
1. Make a new clone of the dex repo: ```
git config [--global] user.signingkey "{{ GPG key ID }}"
git config [--global] user.email "{{ Email associated with key }}"
```
```console Create a signed tag at the commit you wish to release. This action will prompt
$ git clone git@github.com:coreos/dex.git you to enter a tag message, which can just be the release version.
$ cd dex
```
1. Tag with the release name: ```
git tag -s v0.4.0 ea4c04fde83bd6c48f4d43862c406deb4ea9dba2
```
```console Push that tag to the CoreOS repo.
git tag -s v0.4.0
```
1. Push the change: ```
```console git push git@github.com:coreos/dex.git v0.4.0
git push origin v0.4.0 ```
```
1. Make a release with release notes here: Draft releases on GitHub and summarize the changes since the last release. See
https://github.com/coreos/dex/releases previous releases for the expected format.
https://github.com/coreos/dex/releases
Finally create an image tag on Quay corresponding to the release. Log into
Quay, navigate to the `quay.io/coreos/dex` repo, find the correct commit, and
add an additional tag to that image for the release (click the gear on the
image tag's row and then "Add New Tag").
https://quay.io/repository/coreos/dex?tag=latest&tab=tags