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

ci: Auto-generate and publish release notes for minor releases #22514

Merged
merged 12 commits into from
Oct 10, 2024

Conversation

tylerbutler
Copy link
Member

@tylerbutler tylerbutler commented Sep 14, 2024

The transform:releaseNotes command was added in #22466 to enable automated release note creation for minor releases. This change updates the CI pipeline to take advantage of the new capabilities.

AB#19242

@github-actions github-actions bot added area: build Build related issues base: main PRs targeted against main branch labels Sep 14, 2024
@tylerbutler tylerbutler marked this pull request as ready for review October 7, 2024 16:24
@tylerbutler tylerbutler requested a review from a team October 7, 2024 16:25
@tylerbutler tylerbutler changed the title ci: Auto-generate release notes for minor releases ci: Auto-generate and publish release notes for minor releases Oct 7, 2024
.github/workflows/data/release-notes-issue-intro.njk Outdated Show resolved Hide resolved
.github/workflows/push-tag-create-release.yml Outdated Show resolved Hide resolved
.github/workflows/push-tag-create-release.yml Outdated Show resolved Hide resolved
# Generate release notes
- name: Generate patch release notes
# This content is only for patch releases
if: fromJson(env.RELEASE_JSON).releaseType == 'patch'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this now run for patch releases of anything including Independent packages and server? Also, build-tools used to get this step for every kind of release, now it'll be only for its patch releases, and we're explicitly excluding it from the next step, so there won't be auto-generation of any kind for build-tools minors and majors?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this now run for patch releases of anything including Independent packages and server?

Yes. However, I updated it to leave every release except client/server as draft.

Also, build-tools used to get this step for every kind of release, now it'll be only for its patch releases, and we're
explicitly excluding it from the next step, so there won't be auto-generation of any kind for build-tools minors and
majors?

The workflow will fail if the release notes are missing, so I was just going to let them fail. But instead I inverted
the logic from the major/minor releases in this one, so now one of the two steps will be executed on each workflow run.

Copy link
Contributor

@alexvy86 alexvy86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last nit: the comment on line 117 could go away now, or be copied/hoisted to line 106. But not critical.

@tylerbutler tylerbutler enabled auto-merge (squash) October 10, 2024 16:43
@tylerbutler tylerbutler merged commit 1bc44ec into microsoft:main Oct 10, 2024
23 checks passed
@tylerbutler tylerbutler deleted the ci-use-transform-releasenotes branch October 10, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: build Build related issues base: main PRs targeted against main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants