chore: Automate creating and merging documentation release notes during release #644
Conversation
This file contains hidden or 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
KavithaSiva
changed the title
KavithaSiva
commented
Apr 8, 2025
.github/workflows/bump.yml
Outdated
Comment on lines
96
to
98
| TAG_NAME="v${{ needs.bump.outputs.version }}" | ||
| echo "Attempting to delete tag ${TAG_NAME}..." | ||
| git push --delete origin "${TAG_NAME}" || echo "Failed to delete tag ${TAG_NAME} (it might not exist)." |
There was a problem hiding this comment.
Only deleting the tag here, the version commit should also be reverted.
But, I think that would be easier if the commit-and-tag@main action from cloud sdk returns a commit id.
I would do this in a follow-up.
KavithaSiva
commented
Apr 8, 2025
ZhongpinWang
reviewed
Apr 9, 2025
…i-sdk-js into chore/add-release-notes-automation
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.
Context
Closes SAP/ai-sdk-js-backlog#274.
What this PR does and why it is needed
Points to note:
pr-is-mergeableaction is copied over from the Java repoadd-changelogandget-package-versionare scripts copied over from Cloud SDK JSadd-changelogto also accomodate running the script when no initial release notes exist(was useful in testing the docs repo in the current state)bumprun that creates a PR in Docs repopublishrun that checks if PR is mergeable and fails if notpublishit is important that we check and approve the docs PR, else auto merge of the PR fails.