api-go icon indicating copy to clipboard operation
api-go copied to clipboard

GHA to create tags/releases

Open rodrigozhou opened this issue 1 year ago • 1 comments

What changed? GHA to create tag and releases. If a release is created, it also creates a PR in the consumers of api-go for review.

Why? Automation.

How did you test it?

Potential risks

rodrigozhou avatar Jul 19 '24 06:07 rodrigozhou

Can you give some background on the savings here on starting a GH workflow vs publishing release in GH?

cretz avatar Jul 19 '24 11:07 cretz

@cretz Remove potentially some mistakes when releasing a new tag like forgetting to set as latest. Also, with this workflow, we can trigger it whenever the api repo has a new release so they can be in sync.

rodrigozhou avatar Dec 06 '24 18:12 rodrigozhou

Also, with this workflow, we can trigger it whenever the api repo has a new release so they can be in sync.

To confirm, today's approach is:

  • Click release in GH for api
  • Click release in GH for api-go

But this new approach is:

  • Click run workflow in GH for api

So you save a single click, but now you have two more GH workflows to maintain and the user can still mistakenly click release in api/api-go? If we're concerned about users reading release process documentation and may not properly make one of the two releases, how can we know that they will read the documentation to know not to use the GH release feature but instead manual workflow dispatch instead? Are we saving much or just adding GH workflows to maintain?

cretz avatar Dec 06 '24 21:12 cretz

We can further remove the ability of manually triggering the release in api-go, and only be possible from the api repo (basically change workflow_dispatch to workflow_call). Although I'd do in separate PR to make sure it's working as it is first.

rodrigozhou avatar Dec 06 '24 22:12 rodrigozhou