Skip to content

Commit 0f4dfbd

Browse files
committed
Update release docs
1 parent d0661e4 commit 0f4dfbd

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

doc/maintainers/ghc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
cd stack && ./update-global-hints.hs ghc-X.Y.Z
4242

43-
and commit the changes.
43+
and commit and push the changes.
4444

4545

4646
## Building GHC

doc/maintainers/releases.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ Examples:
8484
* Search for old Stack version, unstable stack version, and the next
8585
"obvious" possible versions in sequence, and
8686
`UNRELEASED` and replace with next release version (`X.Y.1`, where Y is odd).
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-
* Do __NOT__ update templates in `.github` to point at the new release version yet!
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+
* Do **NOT** update templates in `.github` to point at the new release version yet!
8989
* Search for old resolvers, set to latest resolver (e.g. in `doc/GUIDE.md` where it references the "currently the latest LTS")
9090
* Look for any links to "latest" (`latest/`) documentation, replace with version tag
9191
* Check that for any platform entries that need to be added to (or removed from)
9292
[releases.yaml](https://github.com/fpco/stackage-content/blob/master/stack/releases.yaml),
93-
[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).
93+
[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.
9494
* `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`)
9595
* `ChangeLog.md`
9696
- 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.
@@ -114,13 +114,17 @@ Examples:
114114
115115
## Release process
116116
117-
* Manually trigger the nightly pipeline on Azure Devops for the branch you are releasing, which will build Linux, macOS, and Windows bindists. `[RC]`
117+
* Trigger the **Integration Tests** workflow on Github Actions for the branch you are releasing, which will build Linux, macOS, and Windows bindists. `[RC]`
118118
119119
* Create a
120120
[new draft Github release](https://github.com/commercialhaskell/stack/releases/new)
121121
with tag and title `vX.Y.Z` (where X.Y.Z matches the version in `package.yaml` from the previous step), targeting the RC branch. In the case of a release candidate, add `(RELEASE CANDIDATE)` to the name field and check the *This is a pre-release* checkbox. `[RC]`
122+
* See previous releases for example formatting and extra info (such as link to website for install instructions).
123+
* For release candidates, you should **skip** the list of contributors and the link to the installation instructions.
124+
* Include the Changelog in the description.
125+
* Use e.g. `git shortlog -s origin/release..HEAD|sed $'s/^[0-9 \t]*/* /'|grep -v azure-pipelines|LC_ALL=C sort -f` to get the list of contributors.
122126
123-
* On each machine you'll be releasing from, set environment variables `GITHUB_AUTHORIZATION_TOKEN` and `STACK_RELEASE_GPG_KEY` (see [stack-release-script's README](https://github.com/commercialhaskell/stack/blob/master/etc/scripts/README.md#prerequisites)). `[RC]`
127+
* On the machine you'll be releasing from, set environment variables `GITHUB_AUTHORIZATION_TOKEN` and `STACK_RELEASE_GPG_KEY` (see [stack-release-script's README](https://github.com/commercialhaskell/stack/blob/master/etc/scripts/README.md#prerequisites)). `[RC]`
124128
125129
* Upload the Azure bindists built by Azure Pipelines to the Gitlab release `[RC]`
126130
* Download the bindist artifacts from the Azure DevOps nightly pipeline build, and put the contents under `_release/`.
@@ -130,16 +134,16 @@ Examples:
130134
stack "etc/scripts/release.hs" --upload-only "$x.upload" "$x.sha256.upload" "$x.asc.upload"
131135
done
132136
137+
TODO: have Github Actions do this automatically.
138+
133139
* For any GPG key used to sign an uploaded bindist, ensure that `[email protected]` signs their key and uploads to SKS keyserver pool:
134140
135141
```
136142
gpg --sign-key -u 0x575159689BEFB442 <OTHER-KEY-ID>
137143
gpg --send-keys <OTHER-KEY-ID>
138144
```
139145
140-
* Publish Github release. Include the Changelog and in the description and use e.g. `git shortlog -s origin/release..HEAD|sed $'s/^[0-9 \t]*/* /'|grep -v azure-pipelines|LC_ALL=C sort -f` to get the list of contributors. See previous releases for example formatting and extra info (such as link to website for install instructions). `[RC]`
141-
142-
* For release candidates, you should skip the list of contributors and the link to the installation instructions.
146+
* Publish the Github release. `[RC]`
143147
144148
* Push signed Git tag, matching Github release tag name, e.g.: `git tag -d vX.Y.Z; git tag -s -m vX.Y.Z vX.Y.Z && git push -f origin vX.Y.Z`. `[RC]`
145149
@@ -153,7 +157,7 @@ Examples:
153157
[readthedocs.org](https://readthedocs.org/projects/stack/versions/), and
154158
ensure that stable documentation has updated.
155159
156-
* Update [get.haskellstack.org /stable rewrite rules](https://gitlab.com/fpco/operations/devops/-/blob/master/kubernetes/fpco-prod-v3/specs/20_get-haskellstack_ingress.yaml) and apply the manifest.
160+
* Update [get.haskellstack.org /stable and /upgrade rewrite rules](https://gitlab.com/fpco/operations/kube/fpcomplete-sites-project/-/blob/master/fpcomplete-redirects/get-haskellstack_virtualservice.yaml) with the new version and [sync the application in ArgoCD](https://v4.fpcomplete.com/argo-cd/applications/fpcomplete-redirects).
157161
158162
* Test with `curl -vL https://get.haskellstack.org/stable/linux-x86_64.tar.gz >/dev/null`, make sure it redirects to the new version
159163

0 commit comments

Comments
 (0)