CSHARP-4918: Release notes automation #1677
Open
+273
−3
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
BorisDog
requested changes
Apr 25, 2025
evergreen/generate-release-notes.sh
Outdated
| if [[ "$version" == *.0 ]]; then | ||
| template_file="./release-notes.yml" | ||
| else | ||
| template_file="./patch-notes.yml" |
evergreen/patch-notes.yml
Outdated
| labels: "*" | ||
|
|
||
| - The full list of issues resolved in this release is available at [CSHARP JIRA project](https://jira.mongodb.org/issues/?jql=project%20%3D%20CSHARP%20AND%20fixVersion%20%3D%20${version}%20ORDER%20BY%20key%20ASC). | ||
| - Documentation on the .NET driver can be found [here](https://www.mongodb.com/docs/drivers/csharp/v${version}}/). |
There was a problem hiding this comment.
I don't think docs link work for version that includes patch: "3.3.1"
evergreen/release-notes.yml
Outdated
| - maintenance | ||
|
|
||
| - The full list of issues resolved in this release is available at [CSHARP JIRA project](https://jira.mongodb.org/issues/?jql=project%20%3D%20CSHARP%20AND%20fixVersion%20%3D%20${version}%20ORDER%20BY%20key%20ASC). | ||
| - Documentation on the .NET driver can be found [here](https://www.mongodb.com/docs/drivers/csharp/v${version}/). |
There was a problem hiding this comment.
I don't think docs link work for version that includes patch: "3.3.1".
evergreen/release-notes.py
Outdated
| total_pages = 1 | ||
| page_size = 100 | ||
| commits_url = "{github_api_base_url}{repo}/compare/{previous_tag}...{version_tag}".format( | ||
| github_api_base_url=opts.github_api_base_url, repo=opts.repo, previous_tag=opts.previous_tag, |
There was a problem hiding this comment.
minor: single line to line for each param?
| for section in opts.template["sections"]: | ||
| if is_in_section(mapped, section): | ||
| if mapped in section["items"]: | ||
| break # PR was already added to the section |
There was a problem hiding this comment.
Yep. If we have multiple PRs for single Jira ticket, then it might be already in the list.
evergreen/release-notes.py
Outdated
|
|
||
| for commit in commits["commits"]: | ||
| pullrequests_url = "{github_api_base_url}{repo}/commits/{commit_sha}/pulls".format( | ||
| github_api_base_url=opts.github_api_base_url, repo=opts.repo, commit_sha=commit["sha"]) |
There was a problem hiding this comment.
Does this mean that we can have multiple PRs for same commit?
There was a problem hiding this comment.
Not sure how to make it possible, but github API has such model, so I suppose somehow it's possible.
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.
No description provided.