Skip to content

Fix release automation to work with md instead of asciidoc #16181

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

Open
carsonip opened this issue Mar 13, 2025 · 3 comments
Open

Fix release automation to work with md instead of asciidoc #16181

carsonip opened this issue Mar 13, 2025 · 3 comments

Comments

@carsonip
Copy link
Member

carsonip commented Mar 13, 2025

From 9.0, docs are markdown files, not asciidoc files. See #16082. Release automation around changelog needs to be updated accordingly.

Note that 8.x still relies on asciidoc.

@endorama
Copy link
Member

endorama commented Apr 3, 2025

Testing the updated automation without triggering a release is problematic. Going forward we will have 2 automations:

We are pausing work on this until the next feature freeze on the 8.x track (next will be 8.17.5 release, expected soon).

@endorama
Copy link
Member

endorama commented Apr 9, 2025

I've been working on this for the 8.17.5 release.

Unfortunately the 8.17.5 automation was already run ~2 weeks ago #16416, so I've only been able to partially test this, as the CI run ended with nothing to do, see https://github.com/elastic/apm-server/actions/runs/14353602051

But I was able to review the workflow for 8.x patch releases:

  • running the workflow from the 8.x branch works
  • we need to update the docs to mention the 8.x release process, PR is up docs: update release docs for v9 #16585
  • we need to update the workflow for the 9.x releases. The PR is up, ci: update changelog release automation #16358 and ready for review. Testing these changes is not trivial, I tried on a fork but there are so many details that didn't work out. I'll engage with our eng prod team to see how this can be achieved.

@endorama
Copy link
Member

The current situation is more convoluted than expected.

TL;DR: the current automation is not working. This will impact the next minor releases.

Next minors

Next minors in main (9.x) line cannot benefit of the current automation, not only due to the changelog automation not been there but also because the automation is currently locked to release minors from 8.x branch. This will be address soon by @v1v, reverting the changes introduced to work on the new 9.x release in September 2024.

Next patches

These versions should not be affected and be working as expected (didn't test it). Note that changelog should be handled manually.

Automation

Once the minor automation is back in place, we will have main (9.x) and 8.x.
8.x will become the last 8 minor (like 7.17 has been for 7.x).

Our changelog automation will need to work on 2 different scenarios:

  1. main/9.x: release notes are on main for all versions and don't need to be backported or be present in any release branch
  2. 8.x: the automation will target 8.x branch (or latest 8 minor) and there is no need to backport to other 8.x release branches

This is addressed in #16358
9.x has been tested by Victor, functioning 8.x is still to assess.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants