binbashar / le-docker-leverage-toolbox

Docker image for https://github.com/binbashar/leverage
3 stars 0 forks source link

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

Open juanmatias opened 1 year ago

juanmatias commented 1 year ago

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:

The ideal workflow should be:

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:

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

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

exequielrafaela commented 7 months ago

@juanmatias this PR (https://github.com/binbashar/le-docker-leverage-toolbox/pull/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