Skip to content

Commit c35cb34

Browse files
committed
Add unlocked workflow step to releasing documentation
1 parent 7cf42a3 commit c35cb34

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/developer-guide/releasing.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,22 @@
1616

1717
All changes must be committed because the working tree is not checked.
1818

19-
6. Update `CHANGELOG.md`:
19+
6. Check that "unlocked" workflow passes on GitHub Actions.
20+
21+
It can be run manually on the release branch for checking.
22+
23+
7. Update `CHANGELOG.md`:
2024

2125
1. Add a desired version number (`vX.Y.Z`) header at the top.
2226
2. Add a list of biggest changes compared to the previous version.
2327

24-
7. Update list of authors in `CITATION.cff` and `dune-project`.
25-
8. Tag the release: `dune-release tag`.
26-
9. Create the distribution archive: `dune-release distrib`.
27-
10. Create a GitHub release with the git tag: `DUNE_RELEASE_DELEGATE=github-dune-release-delegate dune-release publish distrib`.
28+
8. Update list of authors in `CITATION.cff` and `dune-project`.
29+
9. Tag the release: `dune-release tag`.
30+
10. Create the distribution archive: `dune-release distrib`.
31+
11. Create a GitHub release with the git tag: `DUNE_RELEASE_DELEGATE=github-dune-release-delegate dune-release publish distrib`.
2832

2933
Explicitly specify `distrib` because we don't want to publish OCaml API docs.
3034
Environment variable workaround for the package having a Read the Docs `doc` URL (see <https://github.com/ocamllabs/dune-release/issues/154>).
3135

32-
11. Create an opam package: `dune-release opam pkg`.
33-
12. Submit the opam package to opam-repository: `dune-release opam submit`.
36+
12. Create an opam package: `dune-release opam pkg`.
37+
13. Submit the opam package to opam-repository: `dune-release opam submit`.

0 commit comments

Comments
 (0)