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

Enhancement | Add release + notes at GH repo and auto-sync readme (if possible) in DockerHub #34

Open
juanmatias opened this issue Jan 24, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request patch

Comments

@juanmatias
Copy link
Contributor

juanmatias commented Jan 24, 2023

Describe the Enhancement

Add a way to create releases and release notes in the repo and add/update a readme in Docker Hub.

Expected Behavior

To have up-to-date notes.

If possible keep the standard approach and format that's being used across all binbash GH org repos => https://github.com/binbashar/leverage/releases with https://github.com/binbashar/leverage/blob/master/.github/release-drafter.yml

Use Case

When a user wants to know what changes we have in a release, it should be a release page with all the details.

Describe Ideal Solution

Now the workflow is:

  • build an image
  • create a tag

The ideal workflow should be:

  • create a PR
  • merge it to master
  • do the same with all the PRs you need
  • then release drafter will create the draft for all the PRs
  • publish the release
  • the previous action triggers the image build/push with the desired version

Keep in mind we have to figure out how to maintain two different image versions (aka two different releases).
This can be done with version branches. E.g. for versions 1.2.7-0.1.1 and 1.3.5-0.0.1, being the later the main one:

  • from master we build the latter one
  • from release/1.2.7 we build the former one

Another possibility is not to work with master and instead have all release branches and work from there:

  • release/1.2.7
  • release/1.3.5

I don't know how release drafter works, so it has to be researched.

Alternatives Considered

n/a

Additional Context

n/a

@diego-ojeda-binbash @exequielrafaela @angelofenoglio

@juanmatias juanmatias added enhancement New feature or request patch labels Jan 24, 2023
@juanmatias juanmatias self-assigned this Jan 24, 2023
@exequielrafaela exequielrafaela changed the title Enhancement | Add release notes and readme in DockerHub Enhancement | Add release + notes at GH repo and auto-sync readme (if possible) in DockerHub Jan 26, 2023
@exequielrafaela
Copy link
Member

exequielrafaela commented Feb 21, 2024

@juanmatias this PR (#56) intends to cover add/update a readme in Docker Hub with the needed release information via a highlighted link. Still pending the automated releases with comments which should be migrated / handled from CircleCI to GH Actions:

  1. Build, test, push image to dockerhub
  2. Release drafter GH action implementation (same as we do in all other repos).

CC: @diego-ojeda-binbash

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request patch
Projects
None yet
Development

No branches or pull requests

2 participants