Changelog profile parity - GitHub release workflow#2848
Draft
lcawl wants to merge 4 commits intoprofile-parity-p3from
Draft
Changelog profile parity - GitHub release workflow#2848lcawl wants to merge 4 commits intoprofile-parity-p3from
lcawl wants to merge 4 commits intoprofile-parity-p3from
Conversation
Correct the claim that repo/owner are always ignored during profile-based removal. For source: github_release profiles they are actively used to fetch the GitHub release and build the PR URL list. - contribute/changelog.md: replace the blanket "ignored" statement with a per-profile-type breakdown; add a source: github_release removal example and GITHUB_TOKEN note. - changelog-remove.md: same correction to the note in the profile-based removal section; add a dedicated "Remove using a GitHub release profile" subsection with examples and a cross-reference to the profile config fields in changelog-bundle.md. Made-with: Cursor
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR is dependent on #2791, #2808, and #2844.
It should be merged only after all those PRs.
The goal is to add profile-based bundling and removal work with GitHub releases.
For example, the following profile-based command will be equivalent to
changelog bundle --release-version 9.2.0:...where
elasticsearch-releaseis a profile withsource: github_release.Changes
Code (8 files modified, 1 created):
BundleConfiguration.cs— AddedSourceproperty toBundleProfileChangelogConfigurationYaml.cs— AddedSourceproperty toBundleProfileYamlChangelogConfigurationLoader.cs— MapsSourcewhen buildingBundleProfileobjectsProfileFilterResolver.cs— Handlessource: github_releasein a newResolveFromGitHubReleaseAsyncmethod: fetches the release, parses PR references from the release body, and returns them as the filterChangelogBundlingService.cs— Added optionalIGitHubReleaseService?constructor parameter (defaults to a realGitHubReleaseService) and passes it toProfileFilterResolver.ResolveAsyncDocs:
changelog-bundle.md— Addedsourcefield to the profile configuration reference, added agithub_releaseprofile to the examples, and added invocation exampleschangelog-remove.md-- Dittocontribute/changelog.md— Addedsourceto the profile fields table and a new "Bundle changelogs from a GitHub release" subsection with YAML config and invocation exampleschangelog.example.yml— Added a commentedelasticsearch-gh-releaseprofile example showingsource: github_releaseTests (
BundleProfileGitHubReleaseTests.cs) — 9 tests covering:v-prefixed tag nameFetchReleaseAsyncreturningnull→ errorlatestversion tag forwarded correctlyrepoconfig → errorsource: github_release+products→ mutual exclusivity errorsource: github_release+profileReport→ mutual exclusivity errorrepoused as fallback when profile omits it