@@ -28,27 +28,31 @@ on [a special Hackage page](http://hackage.haskell.org/package/clash-prelude/can
28
28
* ` clash-ghc/clash-ghc.cabal `
29
29
* ` clash-cores/clash-cores.cabal `
30
30
* ` docs/conf.py `
31
- 2 . Update the CHANGELOG (see changelog/README.md).
32
- 3 . Create a release branch named after the major version of Clash you're trying to
31
+ 2 . Update the CHANGELOG (see ` changelog/README.md ` ). Each entry should normally
32
+ end with a link to a PR or issue. The script ` changelog/blame_pr.py ` will
33
+ tell you for a single file which PR('s) introduced it.
34
+ 3 . Add a new ` pull_request_rule ` for backports to ` .mergify.yml ` for the branch
35
+ you will create.
36
+ 4 . Create a release branch named after the major version of Clash you're trying to
33
37
release. For example, if you're planning on releasing Clash 1.6.0, create a
34
38
branch called ` 1.6 ` .
35
- 4 . Repeat step (1) in the new release branch.
36
- 5 . Change the defaults of cabal flags in ` clash-prelude/clash-prelude.cabal `
39
+ 5 . Repeat step (1) in the new release branch.
40
+ 6 . Change the defaults of cabal flags in ` clash-prelude/clash-prelude.cabal `
37
41
where necessary. At the time of writing this applies only to
38
42
` -fmultiple-hidden ` .
39
- 6 . Ask someone with admin permissions on GitLab to create a new nightly schedule
43
+ 7 . Ask someone with admin permissions on GitLab to create a new nightly schedule
40
44
and trigger a test release build on [ GitLab CI] ( https://gitlab.com/clash-lang/clash-compiler/pipeline_schedules ) .
41
45
The new schedule should be the same as the old one, but targeting the new
42
46
release branch. Verify that the Hackage release deploys well, and preview
43
47
the release. [ Preview on Hackage] ( http://hackage.haskell.org/package/clash-prelude/candidates/ )
44
- 7 . Write release notes for: Twitter, LinkedIn, and clash-lang.org.
45
- 8 . Create a release on [ GitHub's new release page] ( https://github.com/clash-lang/clash-compiler/releases/new )
46
- 9 . After the release is on Hackage: run ` changelog/comment-gh.py ` and execute
48
+ 8 . Write release notes for: Twitter, LinkedIn, and clash-lang.org.
49
+ 9 . Create a release on [ GitHub's new release page] ( https://github.com/clash-lang/clash-compiler/releases/new )
50
+ 10 . After the release is on Hackage: run ` changelog/comment-gh.py ` and execute
47
51
the commands it lists. This will inform users subscribed to specific issues
48
52
that a fix for their issue is now in a released version.
49
- 10 . Update the [ starter projects] ( https://github.com/clash-lang/stack-templates/ )
50
- 11 . Update these docs if anything is missing :-)
51
- 12 . Enjoy!
53
+ 11 . Update the [ starter projects] ( https://github.com/clash-lang/stack-templates/ )
54
+ 12 . Update these docs if anything is missing :-)
55
+ 13 . Enjoy!
52
56
53
57
## Releasing a new version minor version (1.x.x)
54
58
1 . Change version numbers in:
@@ -59,7 +63,9 @@ on [a special Hackage page](http://hackage.haskell.org/package/clash-prelude/can
59
63
* ` clash-ghc/clash-ghc.cabal `
60
64
* ` clash-cores/clash-cores.cabal `
61
65
* ` docs/conf.py `
62
- 2 . Update the CHANGELOG (see changelog/README.md).
66
+ 2 . Update the CHANGELOG (see ` changelog/README.md ` ). Each entry should normally
67
+ end with a link to a PR or issue. The script ` changelog/blame_pr.py ` will
68
+ tell you for a single file which PR('s) introduced it.
63
69
3 . Ask someone with admin permissions on GitLab to trigger a nightly schedule,
64
70
or simply wait a day. Verify that the Hackage release deploys well, and
65
71
preview the release. [ Preview on Hackage] ( http://hackage.haskell.org/package/clash-prelude/candidates/ )
0 commit comments