Update action versions and standards #41

tagoro9 · 2024-09-16T20:16:12Z

Description

This PR aims to update this repo to use workflows closer to those of actions-node.

Main changes:

Pin action-docs version and make it work
Update several outdated actions
Use semantic-release instead of go-semantic-release
Update release workflow
Update prerelease to add comments as well as only trigger based on labels. Apart from this, I updated the action to leverage goreleaser to push docker images, since now prerelease will generate an RC like version when running on pull requests, meaning that we no longer need to manually push tags. In order for this to work, we have to set create-prerelease to true in a consumer, so that a new tag is created and so that goreleaser has a version to work with. This will create a draft release for every prerelease, but that should be ok, since for non docker releases, goreleaser needs to add the binaries to a release.

TODOs

Address code TODOs
Update the action CI itself (renovatebot, missing workflows, pre-commit, ...)
Remove the need for the go-version input
Ensure the action succeeds when no release is created (go releaser is failing right now)
The docker image comment is not showing the correct info
Reword commits

How has this been tested?

Internally in some libs shared with the reviewers of this PR

Changes

feat: update release and prelease to our standards
ci: trigger on main and remove not needed token
docs: ensure action-docs works correctly
ci: ignore action-docs output for trim whitespace
fix(test): update deps
fix(lint): update deps
fix(deps): use actions-setup-tools@v2
build: pin action-docs major version

🚀 PR created with fotingo

prerelease/action.yaml

tagoro9 · 2024-09-16T22:02:31Z

prerelease/action.yaml

 outputs:
  version:
    description: Version of the project
    value: ${{ steps.release.outputs.version }}
 runs:
  using: composite
  steps:
+    - name: Set vars


Here there is a lot of logic that we are duplicating from actions-node and actions-java. I'm sure there is a better way to not DRY these things (not to be done in this PR)

prerelease/action.yaml

yohanb · 2024-09-17T14:46:30Z

when building and pushing a prerelease docker image, isn't that going to override the latest tag as well?

tagoro9 · 2024-09-17T14:47:44Z

when building and pushing a prerelease docker image, isn't that going to override the latest tag as well?

Oh I haven't checked that. We don't use the latest tag though. I'll do some more testing and ensure that prereleases stay as draft releases

prerelease label, use semantic-release, remove go-version and push docker-snapshot BREAKING CHANGE: The `go-version` and `push-docker-snapshot` inputs no longer exist in the `release` and `reprelease` actions

yohanb

Awesome! Just added a few comments, nothing critical.
Thanks for the work on this.

docs/breaking-changes/v3.md

prerelease/action.yaml

release/action.yaml

yohanb · 2024-09-18T20:34:06Z

script/update-action-readme

-  npx action-docs --no-banner --source "${i}" --update-readme "${readme_file}"
+
+  echo "npx action-docs --no-banner -s "${i}""
+  cd $(dirname "$i")


github-actions · 2024-09-18T21:46:55Z

Release notes preview

Below is a preview of the release notes if your PR gets merged.

3.0.0 (2024-09-18)

⚠ BREAKING CHANGES

The go-version and push-docker-snapshot inputs no
longer exist in the release and reprelease actions

Features

update release and prelease to our standards (73840ba)

Bug Fixes

lint: update deps (3e2e968)
test: update deps (a5b04d3)
deps: use actions-setup-tools@v2 (83facf3)

Build System

pin action-docs major version (be0e6a4)

Continuous Integration

ignore action-docs output for trim whitespace (80ca20f)
trigger on main and remove not needed token (23a3b85)

Documentation

ensure action-docs works correctly (acef6cd)
fix some typos (2d8ca32)
update usage of action-docs and main README.md for all actions (06fb950)
prerelease: update usage of action-docs and main README.md (48fb1a2)

Breaking changes file `docs/breaking-changes/v3.md`

Breaking changes in v3

The go-version input in the release and prerelease actions no longer exists.

The action will use the installed version in the runner.

The push-docker-snapshot input in the prerelease action no longer exists. Instead, set the create-prerelease input to true.

tagoro9 added 4 commits September 16, 2024 18:26

build: pin action-docs major version

be0e6a4

fix(deps): use actions-setup-tools@v2

83facf3

fix(lint): update deps

3e2e968

fix(test): update deps

a5b04d3

tagoro9 force-pushed the f/modernize_actions_go branch from 98cc97b to cc99a02 Compare September 16, 2024 20:56

tagoro9 commented Sep 16, 2024

View reviewed changes

prerelease/action.yaml Show resolved Hide resolved

tagoro9 commented Sep 16, 2024

View reviewed changes

tagoro9 force-pushed the f/modernize_actions_go branch 3 times, most recently from 41f5ada to 548acfb Compare September 16, 2024 22:26

tagoro9 commented Sep 16, 2024

View reviewed changes

prerelease/action.yaml Outdated Show resolved Hide resolved

tagoro9 force-pushed the f/modernize_actions_go branch from 548acfb to 3deabc4 Compare September 16, 2024 23:39

tagoro9 requested a review from yohanb September 16, 2024 23:55

tagoro9 force-pushed the f/modernize_actions_go branch 10 times, most recently from fabbdec to d8b7007 Compare September 18, 2024 20:15

tagoro9 added 4 commits September 18, 2024 20:19

ci: ignore action-docs output for trim whitespace

80ca20f

docs: ensure action-docs works correctly

acef6cd

ci: trigger on main and remove not needed token

23a3b85

feat: update release and prelease to our standards

73840ba

prerelease label, use semantic-release, remove go-version and push docker-snapshot BREAKING CHANGE: The `go-version` and `push-docker-snapshot` inputs no longer exist in the `release` and `reprelease` actions

tagoro9 force-pushed the f/modernize_actions_go branch from d8b7007 to 73840ba Compare September 18, 2024 20:22

tagoro9 marked this pull request as ready for review September 18, 2024 20:24

tagoro9 requested a review from a team as a code owner September 18, 2024 20:24

yohanb approved these changes Sep 18, 2024

View reviewed changes

docs: fix some typos

2d8ca32

tagoro9 force-pushed the f/modernize_actions_go branch from 27898d8 to 2d8ca32 Compare September 18, 2024 21:45

tagoro9 merged commit 5eb4502 into main Sep 18, 2024
2 checks passed

tagoro9 deleted the f/modernize_actions_go branch September 18, 2024 21:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update action versions and standards #41

Update action versions and standards #41

tagoro9 commented Sep 16, 2024 •

edited

Loading

tagoro9 Sep 16, 2024 •

edited

Loading

yohanb commented Sep 17, 2024

tagoro9 commented Sep 17, 2024

yohanb left a comment

yohanb Sep 18, 2024

github-actions bot commented Sep 18, 2024 •

edited

Loading

Update action versions and standards #41

Update action versions and standards #41

Conversation

tagoro9 commented Sep 16, 2024 • edited Loading

tagoro9 Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

yohanb commented Sep 17, 2024

tagoro9 commented Sep 17, 2024

yohanb left a comment

Choose a reason for hiding this comment

yohanb Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 18, 2024 • edited Loading

Release notes preview

3.0.0 (2024-09-18)

⚠ BREAKING CHANGES

Features

Bug Fixes

Build System

Continuous Integration

Documentation

Breaking changes file docs/breaking-changes/v3.md

Breaking changes in v3

tagoro9 commented Sep 16, 2024 •

edited

Loading

tagoro9 Sep 16, 2024 •

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading

Breaking changes file `docs/breaking-changes/v3.md`