Skip to content

Commit

Permalink
format
Browse files Browse the repository at this point in the history
  • Loading branch information
CagtayFabry committed Sep 29, 2021
1 parent 62c1919 commit c82c0e8
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ A short primer in the steps needed to release a new version of the `weldx` packa
## create release PR

- [ ] create a PR that finalizes the code for the next version
- [ ] name the PR according to the version `vX.Y.Z` and add the `release` tag ([example here](https://github.com/BAMWelDX/weldx/pull/419))
- [ ] name the PR according to the version `vX.Y.Z` and add the `release`
tag ([example here](https://github.com/BAMWelDX/weldx/pull/419))
- [ ] make sure `CHANGELOG.md` is up to date and enter current date to the release version
- [ ] add summarized release highlights where appropriate
- [ ] update the `CITATION.cff` version number and date
Expand All @@ -20,21 +21,23 @@ A short primer in the steps needed to release a new version of the `weldx` packa

- [ ] tag and release the current master version on GitHub using the **Releases** feature
- [ ] name the release **git tag** according to the version released (e.g. **v0.3.3**)
- [ ] name the GitHub release accordingly, omitting the **v** prefix (this can be change later so don't worry, in doubt
use **vX.Y.Z** everywhere)
- [ ] name the GitHub release accordingly, omitting the **v** prefix (this can be change later so don't worry, in
doubt use **vX.Y.Z** everywhere)
- [ ] copy the changes/release notes of the current version into the description
- [ ] wait for all Github Actions to finish

## ReadTheDocs update

- [ ] check the build processes for `latest`, `stable` and `vX.Y.Z` get triggered on RTD (the tag build can get triggered twice, resulting in a failed/duplicated build, no need to worry)
- [ ] check the build processes for `latest`, `stable` and `vX.Y.Z` get triggered on RTD (the tag build can get
triggered twice, resulting in a failed/duplicated build, no need to worry)

## pypi release

- [ ] check the automatic release to pypi after the `build` action completes [here](https://pypi.org/project/weldx/)

## conda-forge release

- pypi release should get picked up by the conda-forge bot and create the new pull-request [here](https://github.com/conda-forge/weldx-feedstock/pulls)
- pypi release should get picked up by the conda-forge bot and create the new
pull-request [here](https://github.com/conda-forge/weldx-feedstock/pulls)
- [ ] carefully check the `meta.yaml` in the pull request, manually update all changes in the build and run dependencies
- [ ] merge with 2 or more approved reviews

0 comments on commit c82c0e8

Please sign in to comment.