Skip to content

Commit 921136a

Browse files
committed
docs: add release process notes
1 parent 82b160d commit 921136a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,16 @@ In case you use new dependencies don't forget to either edit `environment.yml` o
9898
A Github action should runs when Rmd files changes so it will verify that the blog post can be built.
9999
However, the converted HTML file along with all generated images are committed to the repository.
100100
This simplifies the deployment and ensures that we have a blog post even when the API or data changes.
101+
102+
103+
### Release Process
104+
105+
The release process is based on [release-it](https://github.com/release-it/release-it). To create a release, run
106+
107+
1. create/checkout the release branch `release` and push to origin
108+
1. run `npm run release` and publish the release
109+
1. create a PR that merges the `release` branch in the `main` branch
110+
1. create a PR that merges the `main` branch back into the `dev` branch
111+
112+
Then go to the release page and update short description of the changes made.
113+

0 commit comments

Comments
 (0)