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

Use chloggen go tool for managing the changelog #637

Merged

Conversation

joaopgrassi
Copy link
Member

@joaopgrassi joaopgrassi commented Jan 11, 2024

Fixes #617

Changes

Today it's very cumbersome how the changes in CHANGELOG.md are managed. It's frustrating for all parties:

  • Contributors have constant merge conflicts in their PRs
  • The process of releasing a new semconv version is very manual, maintainers have to move things around in the markdown file and it's very error-prone
  • When we release a new version, opened PRs that already had changes in the changelog may be misplaced and unless someone looks for it, it's easy to miss. See: Improvements for AWS/ECS attributes #597 (comment)

This PR attempts to add and use the chloggen tool, the same way that the collector repos use.

I also did a revamp in the contributing guide and tried to make it as friendly as possible for new contributors.

Note: It is still missing the new steps for making a release, but once this is merged I will also update that.

@joaopgrassi joaopgrassi added the tooling Regarding build, workflows, build-tools, ... label Jan 11, 2024
@joaopgrassi
Copy link
Member Author

Here is a preview of a CHANGELOG file generated by the new tool (with dummy changelog entries)

vTODO

🛑 Breaking changes 🛑

💡 Enhancements 💡

🧰 Bug fixes 🧰

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

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

Generally LGTM, just a question on some of the CONTRIBUTING refactoring.

CONTRIBUTING.md Show resolved Hide resolved
@joaopgrassi joaopgrassi changed the title Use chloggen go tool for managing changelog Use chloggen go tool for managing the changelog Jan 11, 2024
@joaopgrassi joaopgrassi marked this pull request as ready for review January 17, 2024 16:57
@joaopgrassi joaopgrassi requested review from a team January 17, 2024 16:57
@joaopgrassi
Copy link
Member Author

joaopgrassi commented Jan 17, 2024

Moved this out of draft, as folks may not look at things in that state. I still need to work on the automated checks.

Update: GH Workflow to check the for the changelog entries is there now.

@joaopgrassi joaopgrassi added the Skip Changelog Label to skip the changelog check label Jan 18, 2024
@joaopgrassi joaopgrassi removed the Skip Changelog Label to skip the changelog check label Jan 18, 2024
@joaopgrassi joaopgrassi changed the title Use chloggen go tool for managing the changelog [chore] Use chloggen go tool for managing the changelog Jan 18, 2024
@joaopgrassi joaopgrassi changed the title [chore] Use chloggen go tool for managing the changelog Use chloggen go tool for managing the changelog Jan 18, 2024
@joaopgrassi joaopgrassi added the Skip Changelog Label to skip the changelog check label Jan 18, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@trisch-me trisch-me left a comment

Choose a reason for hiding this comment

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

thanks for working on it!

Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

Thank you!

.chloggen/TEMPLATE.yaml Show resolved Hide resolved
.chloggen/TEMPLATE.yaml Outdated Show resolved Hide resolved
.chloggen/TEMPLATE.yaml Outdated Show resolved Hide resolved
.chloggen/TEMPLATE.yaml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@joaopgrassi joaopgrassi merged commit 379db81 into open-telemetry:main Feb 5, 2024
10 checks passed
@joaopgrassi joaopgrassi deleted the add-chloggen-tool branch February 5, 2024 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Label to skip the changelog check tooling Regarding build, workflows, build-tools, ...
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Tooling: Can we come up with another way to edit CHANGELOG and schema-next.yaml?
5 participants