Skip to content

Commit 228b2a2

Browse files
committed
Clarify release process
1 parent 1bc65c6 commit 228b2a2

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,11 @@ During development
6666

6767
### Releasing
6868

69-
To perform a release
69+
To perform a release (requires maintainers' rights on the repository):
7070
+ Check version to be released is also correct in software components, e.g. `.cabal` files.
7171
+ Replace `UNRELEASED` with a date in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601)
72-
+ Create a signed, annotated git tag of the version: `git tag -as <version>`
73-
+ Use the released changes as annotation
74-
+ (TBD) Publish package on [hackage](https://hackage.haskell.org/)
72+
+ Create a signed, annotated git tag of the version: `git tag -as <version>`, using the released changes as annotation
73+
+ Push the new tag to the remote repository `git push --tags`. This should trigger the [Release](https://github.com/input-output-hk/quickcheck-dynamic/actions/workflows/release.yaml) workflow.
74+
* Note that it's fine to "repush" the tag and retrigger the workflow if a problem is spotted at this moment
75+
* _(Optional)_ Retrieve the artifact attached to the workflow and upload it as a _candidate_ on [Hackage](https://hackage.haskell.org/packages/candidates/upload). This is useful to check everything's right before publishing the release
76+
+ Publish package on [Hackage](https://hackage.haskell.org/) by manually triggering the [Publish workflow](https://github.com/input-output-hk/quickcheck-dynamic/actions/workflows/publish.yaml)

0 commit comments

Comments
 (0)