Skip to content

Commit

Permalink
feat: add a prerelease composite action
Browse files Browse the repository at this point in the history
  • Loading branch information
yohanb committed Sep 10, 2024
1 parent d4aaff0 commit b733115
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 0 deletions.
38 changes: 38 additions & 0 deletions prerelease/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# GitHub Action Release

<!-- prettier-ignore-start -->
<!-- action-docs-description -->
## Description

GitHub Action that produces a new pre-release (snapshot) of a golang based repository.
<!-- action-docs-description -->
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
<!-- action-docs-inputs -->
## Inputs

| parameter | description | required | default |
| --- | --- | --- | --- |
| checkout-repo | Perform checkout as first step of action | `false` | true |
| github-token | GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN' | `true` | |
| go-version | Go version to use for building | `true` | 1.17.3 |
<!-- action-docs-inputs -->

<!-- action-docs-outputs -->
## Outputs

| parameter | description |
| --- | --- |
| version | Version of the project |
<!-- action-docs-outputs -->

<!-- action-docs-runs -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs -->

<!-- action-docs-usage -->
<!-- action-docs-usage -->
<!-- prettier-ignore-end -->
71 changes: 71 additions & 0 deletions prerelease/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: "golang: Pre-release & publish"
description: GitHub Action that produces a new pre-release (snapshot) of a golang based repository.
inputs:
checkout-repo:
required: false
description: Perform checkout as first step of action
default: "true"
github-token:
description: GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'
required: true
go-version:
description: Go version to use for building
required: true
default: 1.17.3
push-docker-snapshot:
description: If a docker snapshot image is generated, push it to the to the registry
required: false
default: "false"
docker-username:
description: Docker username to push the snapshot image to the registry
required: false
docker-password:
description: Docker password to push the snapshot image to the registry
required: false
outputs:
version:
description: Version of the project
value: ${{ steps.release.outputs.version }}
runs:
using: composite
steps:
- name: Checkout
uses: actions/checkout@v4
if: inputs.checkout-repo == 'true'
with:
fetch-depth: 0
- name: Authorize
uses: open-turo/action-git-auth@v2
with:
github-personal-access-token: ${{ inputs.github-token }}
- name: Setup tools
## Installs version of golang found in .go-version
uses: open-turo/action-setup-tools@v2
- name: Semantic release
uses: go-semantic-release/action@v1
id: release
with:
github-token: ${{ inputs.github-token }}
- name: Goreleaser
uses: goreleaser/goreleaser-action@v6
env:
GITHUB_TOKEN: ${{ inputs.github-token }}
GOVERSION: ${{ inputs.go-version }}
with:
args: release --snapshot
- name: Docker login
if: inputs.push-docker-snapshot == 'true'
uses: docker/login-action@v3
with:
username: ${{ inputs.docker-username }}
password: ${{ inputs.docker-password }}
- name: Push Snapshot Image
if: inputs.push-docker-snapshot == 'true'
shell: bash
run: |
# Selects all the docker images that are not the latest tag.
# Maybe this doesn't cover all the cases and we could add an input to specify the tag format to push.
DOCKER_IMAGES=$(jq -r '.[] | select(.type == "Docker Image") | .path' dist/artifacts.json | grep -v ':latest')
for image in $DOCKER_IMAGES; do
docker push $image
done

0 comments on commit b733115

Please sign in to comment.