summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTodd Gamblin <tgamblin@llnl.gov>2020-07-04 01:50:55 -0700
committerTodd Gamblin <tgamblin@llnl.gov>2020-07-06 11:39:19 -0700
commit9ec9327f5aacc7b62a1469771c8917547393676d (patch)
treeade3eec3af5acaff6e0e304f0ae1fdcae5ff82fd /README.md
parent11088df4024a512c8e2fe88f9ffe848e9940f808 (diff)
downloadspack-9ec9327f5aacc7b62a1469771c8917547393676d.tar.gz
spack-9ec9327f5aacc7b62a1469771c8917547393676d.tar.bz2
spack-9ec9327f5aacc7b62a1469771c8917547393676d.tar.xz
spack-9ec9327f5aacc7b62a1469771c8917547393676d.zip
docs: document releases and branches in Spack
- [x] Remove references to `master` branch - [x] Document how release branches are structured - [x] Document how to make a major release - [x] Document how to make a point release - [x] Document how to do work in our release projects
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 21 insertions, 5 deletions
diff --git a/README.md b/README.md
index d278378ce7..2ab9d2dfdf 100644
--- a/README.md
+++ b/README.md
@@ -78,11 +78,27 @@ these guidelines with [Travis CI](https://travis-ci.org/spack/spack). To
run these tests locally, and for helpful tips on git, see our
[Contribution Guide](http://spack.readthedocs.io/en/latest/contribution_guide.html).
-Spack uses a rough approximation of the
-[Git Flow](http://nvie.com/posts/a-successful-git-branching-model/)
-branching model. The ``develop`` branch contains the latest
-contributions, and ``master`` is always tagged and points to the latest
-stable release.
+Spack's `develop` branch has the latest contributions. Pull requests
+should target `develop`, and users who want the latest package versions,
+features, etc. can use `develop`.
+
+Releases
+--------
+
+For multi-user site deployments or other use cases that need very stable
+software installations, we recommend using Spack's
+[stable releases](https://github.com/spack/spack/releases).
+
+Each Spack release series also has a corresponding branch, e.g.
+`releases/v0.14` has `0.14.x` versions of Spack, and `releases/v0.13` has
+`0.13.x` versions. We backport important bug fixes to these branches but
+we do not advance the package versions or make other changes that would
+change the way Spack concretizes dependencies within a release branch.
+So, you can base your Spack deployment on a release branch and `git pull`
+to get fixes, without the package churn that comes with `develop`.
+
+See the [docs on releases](https://spack.readthedocs.io/en/latest/developer_guide.html#releases)
+for more details.
Code of Conduct
------------------------