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

Auto-generate README with tag information #192

Merged
merged 22 commits into from
Dec 13, 2021
Merged

Auto-generate README with tag information #192

merged 22 commits into from
Dec 13, 2021

Conversation

malcyon
Copy link

@malcyon malcyon commented Dec 2, 2021

It seems I've created a mess with having so many different image tags for the docker image (jdk-11, arm64, etc).

The idea here is to auto-generate the Readme using the format suggested in #191, so the releaser doesn't have to manually update each tag in the README.

Replace the static VERSION and VERSION_FORWARDER_PACKAGE files with a version.yaml file that the script can easily parse.

@malcyon malcyon marked this pull request as draft December 2, 2021 21:21
@malcyon malcyon requested review from thll and bernd December 2, 2021 21:57
@malcyon
Copy link
Author

malcyon commented Dec 3, 2021

My thought process on a possible path for improving the release automation:

  • Create a new release.groovy Jenkins pipeline for handling the Docker release. It would handle updating the version.yml, regenerating the README, committing the changes, and adding a new tag. All the stuff we do manually right now.
  • Have a second stage that checks out the new tag.
  • Move the logic from jenkins.groovy that builds the Java 11 and ARM64 images into stage 2 of release.groovy.
  • Add buildx commands to build graylog, graylog-enterprise, and forwarder into release.groovy. This should be easy since the current logic for the ARM64 and Java11 images already mimics all the weird regex tag stuff we do.
  • Disable the Docker Hub automated builds.
  • Now, all our official images would be multiplatform, which removes the need for all the extra arm64 tags. It'll be less confusing and easier to manage (See Image for arm64 architecture tag problem #175).
  • Now that we're building the images on our own CI servers, adding in Content Trust (Enable content trust #23) in a later PR would be easier.

@bernd

@malcyon malcyon changed the title Automate Docker image release Auto-generate README with tag information Dec 8, 2021
@malcyon
Copy link
Author

malcyon commented Dec 8, 2021

Alright, I am going to put the release pipeline stuff in a separate PR and restrict this to just the README changes.

@malcyon malcyon marked this pull request as ready for review December 8, 2021 14:56
thll
thll previously approved these changes Dec 8, 2021
Copy link
Contributor

@thll thll left a comment

Choose a reason for hiding this comment

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

LGTM

README.j2 Show resolved Hide resolved
@malcyon malcyon requested a review from thll December 9, 2021 13:12
thll
thll previously approved these changes Dec 13, 2021
Copy link
Contributor

@thll thll left a comment

Choose a reason for hiding this comment

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

Looks good, but needs to be synchronized with the 4.2 branch now.

@malcyon malcyon merged commit 44ec709 into 4.2 Dec 13, 2021
@malcyon malcyon deleted the auto-ver branch December 13, 2021 14:27
malcyon pushed a commit that referenced this pull request Dec 15, 2021
malcyon pushed a commit that referenced this pull request Jan 5, 2022
* Auto-generate README with tag information (#192)

* Remove VERSION_FORWARDER file.
Update version.yml to latest 4.0 release.

* Update docker/forwarder/hooks/build

Co-authored-by: Othello Maurer <[email protected]>

* Update version.

* Update README.

* Fix forwarder version.

* Fix forwarder version in README.

Co-authored-by: Othello Maurer <[email protected]>
malcyon pushed a commit that referenced this pull request Jan 5, 2022
* Auto-generate README with tag information

* Update version.yml

Co-authored-by: Othello Maurer <[email protected]>

* Update jdk11/arm64 release pipeline to use new version.yml

* Fix forwarder version.

* Update README.

Co-authored-by: Othello Maurer <[email protected]>
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.

2 participants