Skip to content

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jun 18, 2025

This adds an ece_version variable to make life a little easier for us on ECE release days. On each release day we'll now need to:

I've updated the ECE docs release issue template accordingly, via https://github.com/elastic/dev/pull/3187.

Closes: #1789

@eedugon I know you offered to do this, but since I had the release bump PRs in front of me I figured I'd just push the changes myself. Hope that's okay. :-)

@kilfoyle kilfoyle requested a review from eedugon June 18, 2025 15:58
@kilfoyle kilfoyle requested review from a team as code owners June 18, 2025 15:58
Copy link

github-actions bot commented Jun 18, 2025

@eedugon
Copy link
Contributor

eedugon commented Jun 18, 2025 via email

Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

LGTM!
A few small suggestions:

  • For the system deployment versions reference file (not touched in this PR) it would be great to have it using this variable, at least for the latest release. Then whenever we prepare a new release we just need to add one line, while keeping the latest with the variable. What do you think? THe benefit will be that just searching for {{ece_version}} we will also find that file in the future.


```sh
docker save -o ece.4.0.1.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1
docker save -o ece.{{ece_version}}.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}}
Copy link
Contributor

Choose a reason for hiding this comment

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

we need subs=true in all code blocks if they use variables.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching that!

@kilfoyle
Copy link
Contributor Author

For the system deployment versions reference file (not touched in this PR) it would be great to have it using this variable, at least for the latest release. Then whenever we prepare a new release we just need to add one line, while keeping the latest with the variable. What do you think? THe benefit will be that just searching for {{ece_version}} we will also find that file in the future.

It's a great idea, however I worry that it's a bit confusing that the line someone needs to add to the table would be for the previous release. At least, I would find that a bit unintuitive. I put a checklist item in the docs ECE release template saying that we need to add a new line to the system deployment versions table, with a direct link. So that should help make sure people find it and they wouldn't need to search on the ece_versions variable.

Also, I included a comment This table is important so it's a good idea to confirm the system deployment versions with the ECE release coordinator in the template, since you mentioned that the Support folks rely on it.

@kilfoyle kilfoyle merged commit e4f9375 into elastic:main Jun 19, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update ECE docs release template and add a version variable

2 participants