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

Starting semver versioning #34

Merged
merged 4 commits into from
Aug 19, 2024
Merged

Starting semver versioning #34

merged 4 commits into from
Aug 19, 2024

Conversation

j-i-l
Copy link
Collaborator

@j-i-l j-i-l commented Aug 16, 2024

This implements:

  • CHANGELOG.md with automated updates
  • Workflows to prepare and release new version
  • Semver based versioning

@j-i-l
Copy link
Collaborator Author

j-i-l commented Aug 16, 2024

@alexbovet Could you head over to this project on https://readthedocs.org/dashboard/ and add an automation rule for the versioning?

Simply follow these instructions:
https://docs.readthedocs.io/en/stable/guides/automation-rules.html#adding-a-new-automation-rule

choose SemVer for the Match in point 2 and Git tag for Version type in point 3.

This will allow us to have a version specific documentation.

@j-i-l j-i-l marked this pull request as ready for review August 19, 2024 07:52
@j-i-l j-i-l self-assigned this Aug 19, 2024
@alexbovet
Copy link
Owner

I made a new rule with the "activate version" action. ok?

@j-i-l
Copy link
Collaborator Author

j-i-l commented Aug 19, 2024

I made a new rule with the "activate version" action. ok?

Great thanks! Let's try.

@j-i-l j-i-l added the enhancement New feature or request label Aug 19, 2024
@j-i-l j-i-l added this to the JOSS paper submission milestone Aug 19, 2024
@j-i-l j-i-l merged commit db35534 into main Aug 19, 2024
5 of 6 checks passed
@j-i-l j-i-l deleted the starting-semver-versioning branch August 19, 2024 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants