You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/maintainers/releases.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,27 +77,28 @@ Examples:
77
77
78
78
* In RC branch:
79
79
* Review documentation for any changes that need to be made
80
-
* Ensure all documentation pages listed in `mkdocs.yaml`
81
-
(`git diff --stat origin/stable..HEAD doc/`)
80
+
* Ensure all documentation pages listed in `mkdocs.yaml` (use `git diff
81
+
--stat origin/stable..HEAD doc/` to look for new/deleted files)
82
82
* Any new documentation pages should have the "may not be correct for
83
83
the released version of Stack" warning at the top.
84
84
* Search for old Stack version, unstable stack version, and the next
85
85
"obvious" possible versions in sequence, and
86
-
`UNRELEASED` and replace with next release version (`X.Y.1`, where Y is odd).
86
+
`UNRELEASED` and replace with next release version (`X.Y.1`, where Y is odd).
87
87
* Do **NOT** update the Dockerfiles in [stackage/automated/dockerfiles](https://github.com/commercialhaskell/stackage/tree/master/automated/dockerfiles/) yet; that will come later)
88
88
* Do **NOT** update templates in `.github` to point at the new release version yet!
89
89
* Search for old resolvers, set to latest resolver (e.g. in `doc/GUIDE.md` where it references the "currently the latest LTS")
90
90
* Look for any links to "latest" (`latest/`) documentation, replace with version tag
91
91
* Check that for any platform entries that need to be added to (or removed from)
[install_and_upgrade.md](https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md), [get-stack.sh](https://github.com/commercialhaskell/stack/blob/master/etc/scripts/get-stack.sh), and [doc/README.md](https://github.com/commercialhaskell/stack/blob/master/doc/README.md), and get.haskellstack.org redirects.
94
-
* `package.yaml`: bump to next release candidate version (bump patchlevel (fourth) component to next odd number; e.g. from `1.9.0.0` to `1.9.0.1`)
95
-
* `ChangeLog.md`
96
-
- Rename the “Unreleased changes” section to the same version as package.yaml, and mark it clearly as a release candidate (e.g. `v1.9.0.1 (release candidate)`). Remove any empty sections.
97
94
98
95
* For first release candidate:
99
96
* Re-do the pre-release checks (above section)
100
97
* `package.yaml`: bump to first odd patchlevel version (e.g. `X.Y.0.1`)
98
+
* `ChangeLog.md`
99
+
- Rename the “Unreleased changes” section to the same version as
100
+
package.yaml, and mark it clearly as a release candidate (e.g.
101
+
`vX.Y.0.1 (release candidate)`). Remove any empty sections.
101
102
* Follow steps in *Release process* below tagged with `[RC]` to make a release candidate
0 commit comments