Skip to content

Commit

Permalink
Merge pull request #1292 from rallytime/release-docs
Browse files Browse the repository at this point in the history
Add release info to applicable docs
  • Loading branch information
Nicole Thomas committed Nov 8, 2018
2 parents 13e6b3d + 0e5e9ee commit 484ec1b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -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
Expand All @@ -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, `<year.month.day>`.
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
Expand Down
3 changes: 3 additions & 0 deletions README.rst
Expand Up @@ -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
--------

Expand Down
5 changes: 5 additions & 0 deletions 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
#======================================================================================================================
Expand Down

0 comments on commit 484ec1b

Please sign in to comment.