Skip to content

Commit

Permalink
Update release process documentation and changelog entry.
Browse files Browse the repository at this point in the history
  • Loading branch information
Zimmi48 committed May 8, 2019
1 parent 963b950 commit 60e976a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
22 changes: 19 additions & 3 deletions dev/doc/release-process.md
Expand Up @@ -84,10 +84,18 @@
Coq has been tagged.
- [ ] Have some people test the recently auto-generated Windows and MacOS
packages.
- [ ] Change the version name from alpha to beta1 (see
- [ ] In a PR:
- Change the version name from alpha to beta1 (see
[#7009](https://github.com/coq/coq/pull/7009/files)).
We generally do not update the magic numbers at this point.
- We generally do not update the magic numbers at this point.
- Set `is_a_released_version` to `true` in `configure.ml`.
- [ ] Put the `VX.X+beta1` tag using `git tag -s`.
- [ ] Check using `git push --tags --dry-run` that you are not
pushing anything else than the new tag. If needed, remove spurious
tags with `git tag -d`. When this is OK, proceed with `git push --tags`.
- [ ] Set `is_a_released_version` to `false` in `configure.ml`
(if you forget about it, you'll be reminded whenever you try to
backport a PR with a changelog entry).

### These steps are the same for all releases (beta, final, patch-level) ###

Expand All @@ -112,9 +120,17 @@

## At the final release time ##

- [ ] Change the version name to X.X.0 and the magic numbers (see
- [ ] In a PR:
- Change the version name from X.X.0 and the magic numbers (see
[#7271](https://github.com/coq/coq/pull/7271/files)).
- Set `is_a_released_version` to `true` in `configure.ml`.
- [ ] Put the `VX.X.0` tag.
- [ ] Check using `git push --tags --dry-run` that you are not
pushing anything else than the new tag. If needed, remove spurious
tags with `git tag -d`. When this is OK, proceed with `git push --tags`.
- [ ] Set `is_a_released_version` to `false` in `configure.ml`
(if you forget about it, you'll be reminded whenever you try to
backport a PR with a changelog entry).

Repeat the generic process documented above for all releases.

Expand Down
5 changes: 3 additions & 2 deletions doc/changelog/12-misc/09964-changes.rst
Expand Up @@ -8,6 +8,7 @@
`#9668 <https://github.com/coq/coq/pull/9668>`_,
`#9939 <https://github.com/coq/coq/pull/9939>`_,
`#9964 <https://github.com/coq/coq/pull/9964>`_,
and `#10085 <https://github.com/coq/coq/pull/10085>`_,
by Théo Zimmermann,
with help and ideas from Emilio Jesús Gallego Arias,
Clément Pit-Claudel, Matthieu Sozeau, and Enrico Tassi).
with help and ideas from Emilio Jesús Gallego Arias, Gaëtan
Gilbert, Clément Pit-Claudel, Matthieu Sozeau, and Enrico Tassi).

0 comments on commit 60e976a

Please sign in to comment.