Skip to content

Commit a2fbd8f

Browse files
committed
docs: add release doc
1 parent 754c268 commit a2fbd8f

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# fused-effects-logger
2+
23
A logger effect for the
34
[`fused-effects`](https://github.com/fused-effects/fused-effects) library, based
45
on the [`monad-logger`](https://github.com/snoyberg/monad-logger) API.
6+
7+
# Contributing
8+
9+
Please follow the process describe in [`RELEASE.md`](./RELEASE.md) to release
10+
new versions to Hackage.

RELEASE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Release process
2+
3+
This package uses
4+
[`semantic-release`](https://github.com/semantic-release/semantic-release) to
5+
manage versions. In order to release, you need to follow these steps:
6+
7+
1. Push your commit(s) to the default branch, or merge your pull request
8+
2. In the CI pipeline, there will be a workflow called `Semantic release`: you
9+
should wait until this workflow has succeeded; it will produce a new tag and
10+
a release commit with the correct changelog
11+
3. On your local machine, pull the commit and tag and run the command `stack
12+
upload .`; if you want a preview without publishing a definitive version to
13+
Hackage, you can use `stack upload --candidate .` to upload a
14+
[candidate](https://hackage.haskell.org/upload#candidates)

0 commit comments

Comments
 (0)