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

Adds Changed header to buildpack version updates #142

Merged
merged 1 commit into from
Oct 5, 2023

Conversation

colincasey
Copy link
Contributor

  • will merge the updated buildpack versions with any existing Changed entries
  • otherwise will create a new Changed header containing the updated buildpack versions

Fixes #130

- will merge the updated buildpack versions with any existing `Changed` entries
- otherwise will create a new `Changed` header containing the updated buildpack versions
@colincasey colincasey self-assigned this Sep 25, 2023
@colincasey colincasey requested a review from a team as a code owner September 25, 2023 16:28
@edmorley edmorley requested a review from Malax September 27, 2023 10:02
Copy link
Member

@Malax Malax left a comment

Choose a reason for hiding this comment

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

I would've loved to see use working on the AST of the changelog instead of juggling strings. Especially since we already have a parsed representation for the changelog in the Changelog struct. We could extend it to include sub-headings. We could be more strict also since we know which sub-headings would be valid in the keep a changelog spec.

I will not block the PR on this (hence the approve). Please either rework the PR to level-up the Changelog struct or add an issue for it. :)

@colincasey
Copy link
Contributor Author

@Malax I agree. My first iteration was an attempt to build out a more compliant structure for the Keep A Changelog spec but that's complicated by the fact that several of our existing changelogs do not comply with a stricter spec. E.g.;

To do this levelling-up we would need to first discuss the following:

  • How should we deal with those existing non-compliant changelogs?
  • How should we track the "No Changes" case which does easily fit into the spec?

I'll create an issue to track that discussion.

@colincasey
Copy link
Contributor Author

Created #153

@colincasey colincasey merged commit a758ea3 into main Oct 5, 2023
2 checks passed
@colincasey colincasey deleted the fix_missing_changelog_header branch October 5, 2023 12:42
@edmorley edmorley added the bug Something isn't working label Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated changelog for composite buildpacks is missing ### Changed heading
3 participants