diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11614af..ec421fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,7 +140,9 @@ key to your GitHub account. Once these steps are completed, the commit signing verification will look like the example in GitHub's [GPG Signature Verification feature announcement](https://github.com/blog/2144-gpg-signature-verification). -## Release Cadence +## Release Information + +### Release Cadence There is no defined release schedule for the bootstrap script at this time. Typically, SaltStack's release team determines when it would be good to release @@ -154,6 +156,21 @@ Timing the release usually involves an analysis of the following: - Fixes needed for inclusion in an upcoming version of [Salt](https://github.com/saltstack/salt) - Length of time since the last bootstrap release +### Release Process + +The release process consists of the following steps: + +1. Merge in any outstanding PRs that are ready. +1. Add new contributors to the [AUTHORS](https://github.com/saltstack/salt-bootstrap/blob/develop/AUTHORS.rst) file. +1. Update the [ChangeLog](https://github.com/saltstack/salt-bootstrap/blob/develop/ChangeLog). +1. Update the version number in the bootstrap script. The version number is date-based, ``. + For example, version `2018.08.15` was released on August 15, 2018. +1. Merge the `develop` branch into the `stable` branch. +1. Update `bootstrap.saltstack.com` with the new stable release. The checksum on the + [README page](https://github.com/saltstack/salt-bootstrap/blob/develop/README.rst) + should also be updated. +1. Merge the new stable release into [Salt](https://github.com/saltstack/salt). + ## Adding Support for Other Operating Systems The following operating systems are detected, but Salt and its dependency diff --git a/README.rst b/README.rst index 6a8184f..65c1a03 100644 --- a/README.rst +++ b/README.rst @@ -44,6 +44,9 @@ Contributing The Salt Bootstrap project is open and encouraging to code contributions. Please review the `Contributing Guidelines`_ for information on filing issues, fixing bugs, and submitting features. +The `Contributing Guidelines`_ also contain information about the Bootstrap release cadence and +process. + Examples -------- diff --git a/bootstrap-salt.sh b/bootstrap-salt.sh index 9804d88..b7c51d5 100755 --- a/bootstrap-salt.sh +++ b/bootstrap-salt.sh @@ -1,4 +1,9 @@ #!/bin/sh - + +# WARNING: Changes to this file in the salt repo will be overwritten! +# Please submit pull requests against the salt-bootstrap repo: +# https://github.com/saltstack/salt-bootstrap + #====================================================================================================================== # vim: softtabstop=4 shiftwidth=4 expandtab fenc=utf-8 spell spelllang=en cc=120 #======================================================================================================================