feat: doc-deploy-changelog action #452
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…assign someone to PR
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
RobPasMue
approved these changes
Apr 10, 2024
There was a problem hiding this comment.
Awesome job @klmcadams - can't wait to try it out. Just left a few comments (mostly editorial). Logic seems to work fine.
RobPasMue
reviewed
Apr 10, 2024
jorgepiloto
added
release
|
Just labeling this with the blocked for release, similar to other PRs. We will merge all together just before releasing v6. |
|
@jorgepiloto - this shouldn't be blocked I believe. We could merge it to main like we've done with others. Especially now that we are close to v6. |
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
jorgepiloto
reviewed
Apr 10, 2024
klmcadams
commented
Apr 10, 2024
jorgepiloto
removed
the
blocked
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This action creates a new section in the CHANGELOG.md file using the towncrier file fragments located in doc/changelog.d. By default, it updates the CHANGELOG in the release branch corresponding to the tag. For example, if the tag is v0.1.0, the action is going to assume its release branch is "release/0.1". Once it updates the changelog in the release branch, it creates a pull request into main containing the changelog update and the deleted fragment files, deletes the old tag, and recreates it with the changelog update.
If you add the "package" line under the "tool.towncrier" section and set it equal to the value of the name in "tool.flit.module" ("ansys.."), towncrier will use the version listed in the pyproject.toml file. Otherwise, it will take the version from the tag: v0.1.0 -> 0.1.0.
The action also handles cherry-pick conflicts. It takes all of "their" changes, which are the changes from the initial changelog update & fragment files being deleted.
If for some reason you push a tag, v0.2.0 and the release branch, release/0.2, doesn't exist, the action will use the temporary branch to update the changelog & merge the changes into main. This may be an overkill check, so if you think it's unnecessary it can be removed.