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.

Sign up for GitHub

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

Jump to bottom

Modify action to build and consume container #124

Merged
merged 6 commits into from
Mar 29, 2021
Merged

Modify action to build and consume container #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
98bf124
feat: modify action to build and consume container
weierophinney Mar 3, 2021
8af0b90
refactor: use JSON outputs instead of multiline
weierophinney Mar 12, 2021
79c6f57
fix: use CSV instead of multi-line list for tags input
weierophinney Mar 16, 2021
9c34762
qa: prefix secrets to make clear they are specific to this repo
weierophinney Mar 29, 2021
dc9d0b0
qa: whitespace between job steps in container build workflow
weierophinney Mar 29, 2021
efeff72
qa: simplify bash pattern matching when matching tag name
weierophinney Mar 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/actions/automatic-releases/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Definition of the github action
# as per https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action

name: 'laminas/automatic-releases'
description: 'Automates automatic releases for semver-compliant repositories'

inputs:
command-name:
description: |
Command to execute: one of
* `laminas:automatic-releases:release`
* `laminas:automatic-releases:create-merge-up-pull-request`
* `laminas:automatic-releases:switch-default-branch-to-next-minor`
required: true

runs:
using: 'docker'
image: '../../../Dockerfile'
args:
- ${{ inputs.command-name }}
Comment on lines +16 to +20
Copy link
Member Author

@weierophinney weierophinney Mar 3, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I discovered is that while the image is in a directory relative to this one, the actual build happens relative to $GITHUB_WORKSPACE, so everything works correctly. By doing this, we get the benefits of whatever changes we've made for this release... when creating the release.

10 changes: 5 additions & 5 deletions .github/workflows/automatic-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
uses: "actions/checkout@v2"

- name: "Release"
uses: "./"
uses: "./.github/actions/automatic-releases/"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this part ensures we use that local action, which builds from the Dockerfile directly instead of using the image.

with:
command-name: "laminas:automatic-releases:release"
env:
Expand All @@ -27,7 +27,7 @@ jobs:
"GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}

- name: "Create Merge-Up Pull Request"
uses: "./"
uses: "./.github/actions/automatic-releases/"
with:
command-name: "laminas:automatic-releases:create-merge-up-pull-request"
env:
Expand All @@ -37,7 +37,7 @@ jobs:
"GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}

- name: "Create and/or Switch to new Release Branch"
uses: "./"
uses: "./.github/actions/automatic-releases/"
with:
command-name: "laminas:automatic-releases:switch-default-branch-to-next-minor"
env:
Expand All @@ -47,7 +47,7 @@ jobs:
"GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}

- name: "Bump Changelog Version On Originating Release Branch"
uses: "./"
uses: "./.github/actions/automatic-releases/"
with:
command-name: "laminas:automatic-releases:bump-changelog"
env:
Expand All @@ -57,7 +57,7 @@ jobs:
"GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}

- name: "Create new milestones"
uses: "./"
uses: "./.github/actions/automatic-releases/"
with:
command-name: "laminas:automatic-releases:create-milestones"
env:
Expand Down
44 changes: 44 additions & 0 deletions .github/workflows/build-and-push-containers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build and push containers

on:
release:
types: [published]

jobs:
release-container:
runs-on: ubuntu-latest
steps:
- name: Compile tag list
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you could use https://github.com/crazy-max/ghaction-docker-meta here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True - but this is fast and doesn't require any additional overhead as it's using tooling already in the environment.

Thanks for the link, though - I'd not seen that one!

id: tags
run: |
TAG=${GITHUB_REF#refs/tags/}
PREFIX=ghcr.io/laminas/automatic-releases
MAJOR="${PREFIX}:$(echo ${TAG} | cut -d. -f1)"
MINOR="${MAJOR}.$(echo ${TAG} | cut -d. -f2)"
PATCH="${PREFIX}:${TAG}"
echo "::set-output name=tags::[\"${MAJOR}\",\"${MINOR}\",\"${PATCH}\"]"

- name: Checkout
uses: actions/checkout@v2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not super-important, but some spacing (blank lines around blocks) would go a long way with improving readability

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!


- name: Setup QEMU
uses: docker/setup-qemu-action@v1

- name: Setup Docker Buildx
uses: docker/setup-buildx-action@v1

- name: Login to GitHub Container Registry
uses: docker/login-action@v1
with:
registry: ghcr.io
username: ${{ secrets.AUTOMATIC_RELEASES_CONTAINER_USERNAME }}
password: ${{ secrets.AUTOMATIC_RELEASES_CONTAINER_PAT }}

- name: Build and push
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/amd64
push: true
tags: ${{ join(fromJSON(steps.tags.outputs.tags), ",") }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we push each image as 3 tags? Ok for me, hard to read/follow if not versed in github actions (requires comments around it)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - actual release version, minor release version, major release version.

Rationale is that if we change something in a new minor release that causes issues for somebody, they can pin to the previous minor. Alternately, they can pin to a specific "known good" release. (There are existing actions for creating tags that do the same; I chose to do it using standard *nix tooling, as it introduces zero additional overhead.)

2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ inputs:

runs:
using: 'docker'
image: 'Dockerfile'
image: 'docker://ghcr.io/laminas/automatic-releases:1'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the magic: the action now uses an image on ghcr.io, which means only a pull operation is required, and no build operations!

args:
- ${{ inputs.command-name }}