forked from TrueCloudLab/certificates
Remove distribution doc.
This commit is contained in:
max furman
parent
bc4bf224e8
commit
9a156d2210
1 changed files with 0 additions and 143 deletions
143
distribution.md
143
distribution.md
|
|
@ -1,143 +0,0 @@
|
||||||
# Distribution
|
|
||||||
|
|
||||||
This section describes how to build and deploy publicly available releases of
|
|
||||||
the Step CA.
|
|
||||||
|
|
||||||
## Creating A New Release
|
|
||||||
|
|
||||||
New releases are (almost) entirely built and deployed by Travis-CI. Creating a new
|
|
||||||
release is as simple as pushing a new github tag.
|
|
||||||
|
|
||||||
**Definitions**:
|
|
||||||
|
|
||||||
* **Standard Release**: ready for public use. no `-rc*` suffix on the version.
|
|
||||||
e.g. `v1.0.2`
|
|
||||||
* **Release Candidate**: not ready for public use, still testing. must have a
|
|
||||||
`-rc*` suffix. e.g. `v1.0.2-rc` or `v1.0.2-rc.4`
|
|
||||||
|
|
||||||
---
|
|
||||||
1. **Tag it!**
|
|
||||||
|
|
||||||
1. Find the most recent tag.
|
|
||||||
|
|
||||||
```
|
|
||||||
$> git fetch --tags
|
|
||||||
$> git tag
|
|
||||||
```
|
|
||||||
|
|
||||||
The new tag needs to be the logical successor of the most recent existing tag.
|
|
||||||
See [versioning](#versioning) section for more information on version numbers.
|
|
||||||
|
|
||||||
2. Select the type and value of the next tag.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
```
|
|
||||||
# standard release
|
|
||||||
$> git tag v1.0.3
|
|
||||||
...or
|
|
||||||
# release candidate
|
|
||||||
$> git tag v1.0.3-rc.1
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Push the new tag to the remote origin.
|
|
||||||
|
|
||||||
```
|
|
||||||
# standard release
|
|
||||||
$> git push origin tag v1.0.3
|
|
||||||
...or
|
|
||||||
# release candidate
|
|
||||||
$> git push origin tag v1.0.3-rc.1
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Check the build status at**
|
|
||||||
[Travis-CI](https://travis-ci.com/smallstep/certificates/builds/).
|
|
||||||
|
|
||||||
Travis will begin by verifying that there are no compilation or linting errors
|
|
||||||
and then run the unit tests. Assuming all the checks have passed, Travis will
|
|
||||||
build Darwin and Linux artifacts (for easily installing `step`) and upload them
|
|
||||||
as part of the [Github Release](https://github.com/smallstep/certificates/releases).
|
|
||||||
|
|
||||||
Travis will build and upload the following artifacts:
|
|
||||||
|
|
||||||
* **step-ca_1.0.3_amd64.deb**: debian package for installation on linux.
|
|
||||||
* **step-ca_linux_1.0.3_amd64.tar.gz**: tarball containing a statically compiled linux binary.
|
|
||||||
* **step-ca_darwin_1.0.3_amd64.tar.gz**: tarball containing a statically compiled darwin binary.
|
|
||||||
* **step-ca_1.0.3.tar.gz**: tarball containing a git archive of the full repo.
|
|
||||||
|
|
||||||
3. **Update the AUR Arch Linux package**
|
|
||||||
|
|
||||||
> **NOTE**: if you plan to release `cli` next then you can skip this step.
|
|
||||||
|
|
||||||
<pre><code>
|
|
||||||
<b>$ cd archlinux</b>
|
|
||||||
|
|
||||||
# Get up to date...
|
|
||||||
<b>$ git pull origin master</b>
|
|
||||||
<b>$ make</b>
|
|
||||||
|
|
||||||
<b>$ ./update --ca v1.0.3</b>
|
|
||||||
</code></pre>
|
|
||||||
|
|
||||||
4. **Update the Helm packages**
|
|
||||||
|
|
||||||
> **NOTE**: This is an optional step, only necessary if we want to release a
|
|
||||||
> new helm package.
|
|
||||||
|
|
||||||
Once we have the docker images, we can release a new version in our Helm
|
|
||||||
[repository](https://smallstep.github.io/helm-charts/) we need to pull the
|
|
||||||
[helm-charts](https://github.com/smallstep/helm-charts) project, and change the
|
|
||||||
following:
|
|
||||||
|
|
||||||
* On step-certificates/Chart.yaml:
|
|
||||||
* Increase the `version` number (Helm Chart version).
|
|
||||||
* Set the `appVersion` to the step-certificates version.
|
|
||||||
* On step-certificates/values.yaml:
|
|
||||||
* Set the docker tag `image.tag` to the appropriate version.
|
|
||||||
|
|
||||||
Then create the step-certificates package running:
|
|
||||||
|
|
||||||
<pre><code>
|
|
||||||
<b>$ helm package ./step-certificates</b>
|
|
||||||
</code></pre>
|
|
||||||
|
|
||||||
A new file like `step-certificates-<version>.tgz` will be created.
|
|
||||||
Now commit and push your changes (don't commit the tarball) to the master
|
|
||||||
branch of `smallstep/helm-charts`
|
|
||||||
|
|
||||||
Next checkout the `gh-pages` branch. `git add` the new tar-ball and update
|
|
||||||
the index.yaml using the `helm repo index` command:
|
|
||||||
|
|
||||||
<pre><code>
|
|
||||||
<b>$ git checkout gh-pages</b>
|
|
||||||
<b>$ git pull origin gh-pages</b>
|
|
||||||
<b>$ git add "step-certificates-<version>.tgz"</b>
|
|
||||||
<b>$ helm repo index --merge index.yaml --url https://smallstep.github.io/helm-charts/ .</b>
|
|
||||||
<b>$ git commit -a -m "Add package for step-certificates vX.Y.Z"</b>
|
|
||||||
<b>$ git push origin gh-pages</b>
|
|
||||||
</code></pre>
|
|
||||||
|
|
||||||
***All Done!***
|
|
||||||
|
|
||||||
## Versioning
|
|
||||||
|
|
||||||
We use [SemVer](http://semver.org/) for versioning. See the
|
|
||||||
[tags on this repository](https://github.com/smallstep/certificates) for all
|
|
||||||
available versions.
|
|
||||||
Loading…
Add table
Reference in a new issue