alexvanin/certificates
1
0
Fork 0
forked from TrueCloudLab/certificates
Code Pull requests Activity

docs: Streamlined distribution docs

Browse source
This commit is contained in:
max furman 2019-02-21 15:27:55 -08:00
parent c23eb88a4f
commit bdc05d40e6
1 changed files with 51 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

94
docs/distribution.md
View file

@ -16,59 +16,62 @@ e.g. `v1.0.2`
`-rc*` suffix. e.g. `v1.0.2-rc` or `v1.0.2-rc.4` `-rc*` suffix. e.g. `v1.0.2-rc` or `v1.0.2-rc.4`
1. Find the most recent tag. 1. **Commit all changes.**
``` Make sure that the local checkout is up to date with the remote origin and
git fetch --tags that all local changes have been pushed.
git tag
```
The new tag needs to be the logical successor of the most recent existing tag.
See [versioning](./README.md#versioning) section for more information on version numbers.
2. Select the next tag (but don't actually tag anything yet!!).
Is the new release a *release candidate* or a *standard release*?
1. Release Candidate
If the most recent tag is a standard release, say `v1.0.2`, then the version
of the next release candidate should be `v1.0.3-rc.1`. If the most recent tag
is a release candidate, say `v1.0.2-rc.3`, then the version of the next
release candidate should be `v1.0.2-rc.4`.
2. Standard Release
If the most recent tag is a standard release, say `v1.0.2`, then the version
of the next standard release should be `v1.0.3`. If the most recent tag
is a release candidate, say `v1.0.2-rc.3`, then the version of the next
standard release should be `v1.0.3`.
3. Update the remote origin with your commits.
Make sure that the local checkout is up to date with
with the remote origin and that all local changes have been pushed.
``` ```
git pull --rebase origin master git pull --rebase origin master
git push git push
``` ```
4. Create a local tag. 2. **Tag it!**
``` 1. **Find the most recent tag.**
git tag v1.0.3 # standard release
...or
git tag v1.0.3-rc.1 # release candidate
```
5. Push the new tag to the remote origin. ```
git fetch --tags
git tag
```
``` The new tag needs to be the logical successor of the most recent existing tag.
git push origin tag v1.0.3 # standard release See [versioning](#versioning) section for more information on version numbers.
...or
git push origin tag v1.0.3-rc.1 # release candidate 2. **Select the next tag (but don't actually tag anything yet!!).**
```
Is the new release a *release candidate* or a *standard release*?
1. Release Candidate
If the most recent tag is a standard release, say `v1.0.2`, then the version
of the next release candidate should be `v1.0.3-rc.1`. If the most recent tag
is a release candidate, say `v1.0.2-rc.3`, then the version of the next
release candidate should be `v1.0.2-rc.4`.
2. Standard Release
If the most recent tag is a standard release, say `v1.0.2`, then the version
of the next standard release should be `v1.0.3`. If the most recent tag
is a release candidate, say `v1.0.2-rc.3`, then the version of the next
standard release should be `v1.0.3`.
3. **Create a local tag.**
```
git tag v1.0.3 # standard release
...or
git tag v1.0.3-rc.1 # release candidate
```
4. **Push the new tag to the remote origin.**
```
git push origin tag v1.0.3 # standard release
...or
git push origin tag v1.0.3-rc.1 # release candidate
```
6. Check the build status at 6. Check the build status at
[Travis-CI](https://travis-ci.com/smallstep/certificates/builds/). [Travis-CI](https://travis-ci.com/smallstep/certificates/builds/).
@ -85,3 +88,8 @@ e.g. `v1.0.2`
* **step-ca_1.0.3_darwin_amd64.tar.gz**: tarball containing a statically compiled darwin binary. * **step-ca_1.0.3_darwin_amd64.tar.gz**: tarball containing a statically compiled darwin binary.
*All Done!* *All Done!*
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/smallstep/certificates).