Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.6.8 #934

Merged
merged 3 commits into from
Jun 7, 2024
Merged

v0.6.8 #934

merged 3 commits into from
Jun 7, 2024

Conversation

CagtayFabry
Copy link
Member

@CagtayFabry CagtayFabry commented Jun 7, 2024

How to release

A short primer in the steps needed to release a new version of the weldx package

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)
    • 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
    • search the project for deprecated and remove deprecated code
  • wait for review and the CI jobs to finish
  • check the readthedocs PR build

Merge the Pull Request

  • merge normally and wait for all CI actions to finish on the main branch

add Git(hub) tag

  • 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)
    • copy the changes/release notes of the current version into the description and change the GitHub PR links to GitHub markdown
  • wait for all Github Actions to finish

ReadTheDocs updates

  • 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

conda-forge release

  • pypi release should get picked up by the conda-forge bot and create the new
    pull-request here
  • 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

Copy link

github-actions bot commented Jun 7, 2024

Test Results

2 188 tests  ±0   2 187 ✅ ±0   2m 49s ⏱️ -4s
    1 suites ±0       1 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit 16f564a. ± Comparison against base commit 8d816ed.

♻️ This comment has been updated with latest results.

@CagtayFabry CagtayFabry merged commit f750e8a into master Jun 7, 2024
28 checks passed
@CagtayFabry CagtayFabry deleted the v0.6.8 branch June 7, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant