Skip to content

[docs] Remove AsciiDoc changelog file #2569

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[docs] Remove AsciiDoc changelog file #2569

wants to merge 4 commits into from

Conversation

colleenmcginnis
Copy link
Contributor

Follow up to #2557

Removes CHANGELOG.asciidoc. Use docs/release-notes/index.md instead.

Notes:

  • Findability: I removed this to prevent anyone from editing this file. If you're concerned about users expecting a changelog file at the top level of this repo, let me know and I can also add a Markdown file like this one we added in /apm-server.
  • Automation: It looks like .github/workflows/release.yml expects a CHANGELOG.asciidoc file. I'm not exactly sure how this works, but let me know if I can help at all.

@colleenmcginnis colleenmcginnis added docs Team:Docs Label for the Observability docs team labels Mar 13, 2025
@colleenmcginnis colleenmcginnis requested a review from a team March 13, 2025 22:12
@colleenmcginnis colleenmcginnis self-assigned this Mar 13, 2025
@stevejgordon
Copy link
Contributor

@colleenmcginnis, on further reflection, having a markdown CHANGELOG does make sense, I think.

@stevejgordon
Copy link
Contributor

@colleenmcginnis I've removed the post-release step from the release workflow.

@stevejgordon stevejgordon self-requested a review August 21, 2025 10:18
stevejgordon
stevejgordon requested changes Aug 21, 2025
View reviewed changes
Copy link
Contributor

@stevejgordon stevejgordon left a comment

Choose a reason for hiding this comment

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

Let's add the links to the new change notes, just in case people are looking for a CHANGELOG.md in the root.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevejgordon stevejgordon stevejgordon approved these changes

Assignees

@colleenmcginnis colleenmcginnis

Labels
docs Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@colleenmcginnis @stevejgordon