feat(gha): add docker push github action by georgettica · Pull Request #1116 · crate-ci/typos

georgettica · 2024-10-08T21:22:38Z

fixes #427

georgettica · 2024-10-08T21:23:12Z

this is not tested fully, but I am hopeful this just works.

georgettica · 2024-10-08T21:24:47Z

@epage , this is my "throw this and check if it sticks"

I added the manual trigger if you want to play with it manually, before pushing to continuus-deployment

if you want me to integrate with other github actions I can spend time on this too

epage · 2024-10-08T21:27:21Z

As this is a completely new workflow to me, posting an Action is insufficient. I specifically asked for documentation. I need to understand the workflow and the requirements it places on me.

weijiany · 2024-10-09T01:27:24Z

.github/workflows/push-docker-on-release.yml

+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4


Maybe only fetch 1 depth is sufficient.

did not find a way to change it to the way you want. I saw the default fetch-depth is 1

weijiany · 2024-10-09T01:36:09Z

.github/workflows/push-docker-on-release.yml

+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:${{ steps.get_tag.outputs.tag }}


We also need to build multi-architecture images alongside the CLI release

ill do it along the weekend 🍾

my weekend was not very useful, so found time to push this now

georgettica · 2024-10-09T07:54:45Z

oh sorry @epage , I will create the documentation on how this workflow works in addition to the changes requested in the review

georgettica · 2024-10-14T17:55:06Z

@weijiany care to check on your machine?

docker build --tag typos --platform "linux/arm64/v8,linux/amd64" .

( I use podman so I just replaced it with docker hoping it just works )

Dockerfile

georgettica · 2024-10-14T18:10:59Z

It is worth noting ChatGPT is a good friend of mine, so he is a co-author.

I hope this is ok by you ❤️

weijiany · 2024-10-15T05:51:57Z

@weijiany care to check on your machine?
docker build --tag typos --platform "linux/arm64/v8,linux/amd64,linux/amd64" .
( I use podman to I just replaced it with docker hoping it just works )

Hi @georgettica, it works well. ✅

BTW, I am not the repository's maintainer; I am simply a user who wishes to directly utilize the image.

weijiany · 2024-10-15T05:46:48Z

.github/workflows/push-docker-on-release.yml

+          tags: ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:${{ steps.get_tag.outputs.tag }}
+          # platforms: linux/arm64/v8,darwin/amd64,linux/amd64,windows/amd64,linux/amd64 # was what I was aiming for 
+          # but locally I only got to these 3 (specifically linux/arm64/v8 but yeah)
+          platforms: linux/arm64,linux/amd64


TBH, I didn't work with on Github action to build multi-arch. But in some pipeline tool that I have used, a question is needn't we to install qemu before building image?’

That makes sense. I can add it, but I am adding the required tools inside the docker, so I hope it "just works".

georgettica · 2024-10-15T05:56:38Z

PS, I accidentally had one of the tools twice: linux/amd64,linux/amd64 but it isn't a real issue

georgettica · 2024-10-15T07:17:36Z

@weijiany, I guess the only other thing I want to ask so we can move this PR forward is your thoughts and opinions on the documentation I cobbled up.

weijiany · 2024-10-15T07:23:39Z

@weijiany, I guess the only other thing I want to ask so we can move this PR forward is your thoughts and opinions on the documentation I cobbled up.

For me, the doc is quite clear, possibly because I've reviewed your changes by going through the GitHub Actions documentation. 😅

georgettica · 2024-10-15T08:33:28Z

Well, at least it's clear. I hope it'll be ok once the actual review comes around

georgettica · 2024-10-21T08:35:51Z

@epage, can I get 👀 ? (sorry for pinging, I don't want this PR to go to waste)

epage · 2024-10-21T08:41:55Z

You are in my queue of prs and issues to get to.

Be sure the commits are all atomic and organized for how you want me to review and merge this.

georgettica · 2024-10-22T16:31:16Z

I made them into one big blob, as they weren't atomic and some were patch fixes.

I am ok with all the PR not passing as it's one atomic change.

coveralls · 2024-10-22T16:40:24Z

Pull Request Test Coverage Report for Build 11464483713

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 22.789%

Totals
Change from base Build 11432065555:	0.0%
Covered Lines:	536
Relevant Lines:	2352

💛 - Coveralls

mjpieters · 2024-10-25T12:56:41Z

I'm looking forward to this landing, because that'd make it much, much easier to install typos into our dev docker containers!

COPY --from=ghcr.io/crate-ci/typos:latest /typos /bin/

instead of installingcargo-binstall then cargo-binstall typos, which can run into Github API rate limits quite quickly on a CI.

I see your commit message failed the linter; should be easy to fix:

git commit --amend --message 'feat(gha): Add docker push github action'
git force --push

georgettica · 2024-10-27T19:05:35Z

took me a while, but let's hope this passes 🤞

georgettica · 2024-10-27T19:08:17Z

@mjpieters I would be really happy if this works, lets see though

epage · 2024-10-30T20:00:27Z

.github/workflows/push-docker-on-release.yml

+  release:
+    types: [published]


Building of binaries is kicked off from a tag, rather than release. Should we do that here as well?

typos/.github/workflows/post-release.yml

Lines 16 to 21 in 0d9e0c2

name: post-release

on:

push:

tags:

- "v*.*.*"

- "!varcon*"

this can be done, for sure!

epage · 2024-10-30T20:01:20Z

.github/workflows/push-docker-on-release.yml

+        id: get_tag
+        run: |
+          if [ "${{ github.event_name }}" == "release" ]; then
+            echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT


If we do this off of a tag, could we simplify this to

typos/.github/workflows/post-release.yml

Line 43 in 0d9e0c2

run: echo "TAG=${{ github.ref_name }}" >> $GITHUB_ENV

i'll do that too

epage · 2024-10-30T20:02:37Z

.github/workflows/push-docker-on-release.yml

+          # platforms: linux/arm64/v8,darwin/amd64,linux/amd64,windows/amd64,linux/amd64 # was what I was aiming for 
+          # but locally I only got to these 3 (specifically linux/arm64/v8 but yeah)
+          platforms: linux/arm64,linux/amd64


This feels like a during-development note and I'd like it resolved one way or the other

My PC is MacOS, so I don't have much wiggle room for testing.

I would give it a go if I had more computers with different platforms.

epage · 2024-10-30T20:04:35Z

Dockerfile

@@ -1,11 +1,82 @@
-ARG DEBIAN_DIST=bullseye
+# syntax=docker/dockerfile:1.10


This is a complete rewrite of the dockerfile

Can any of this be broken out into smaller (complete) steps (ie commits) to make this easier to follow along?

Sure, I can do that, sorry for the mess. This process is more complex for me so I opted to give one big commit and break it into tiny bits if required (mostly because my work was based inside.

@epage you are correct, but the reason I did this is to allow compiling the code to multiple architectures based on TARGETPLATFORM arg (filled by the --platform flag in docker build)

epage · 2024-10-30T20:05:32Z

docs/build_and_push_docker_image_workflow_documentation.md

@@ -0,0 +1,219 @@
+# Build and Push Docker Image Workflow Documentation


When I said that I wanted it documented, I meant a write up in the issue or PR so I could understand the expectations behind this. Unsure how much of this will be useful in a living document. If there is, it likely more belongs in CONTRIBUTING.md

sure, I will move it there, as moving documentation is easier than rewriting.

Based on the understanding from #1116 (comment), I don't think we need to keep this documentation.

epage · 2024-10-30T20:08:51Z

docs/build_and_push_docker_image_workflow_documentation.md

+- **GitHub Permissions**: The `GITHUB_TOKEN` provided by GitHub Actions must have the necessary permissions (default settings typically suffice).
+- **Understanding of Docker and GHCR**: Basic knowledge of Docker image building and pushing to GHCR will be beneficial.


This was the core of what I was wanting to understand.

If I get the gist of it, instead of us pushing to docker hub, we are pushing to github's container registry which allows us to just use GH_TOKEN without having to setup any count, register secrets, and/or do any manual per-release action.

Is that right?

yes, that is the gist.

I think GH_TOKEN is if you run it manually, so most times the action won't need even permissions to run.

georgettica · 2024-11-03T11:26:30Z

Worth noting to all I am not quick with PR modifications, but I hope this will soon go through another cycle (and I will ping all of you when it is)

georgettica · 2024-12-22T11:14:55Z

seems this PR is getting a lot of traction and I am not getting enough time to sit on it.

if anyone wants to grab what I have so far and push it across the finish line be my guest

weijiany reviewed Oct 9, 2024

View reviewed changes

georgettica requested a review from weijiany October 14, 2024 17:55

georgettica commented Oct 14, 2024

View reviewed changes

Dockerfile Show resolved Hide resolved

weijiany reviewed Oct 15, 2024

View reviewed changes

georgettica force-pushed the georgettica/feat/gha/add-docker-push-github-action branch 2 times, most recently from 91f9eb2 to 0a1a113 Compare October 22, 2024 16:28

feat(gha): Add docker push github action

f629cac

georgettica force-pushed the georgettica/feat/gha/add-docker-push-github-action branch from 0a1a113 to f629cac Compare October 27, 2024 19:05

epage reviewed Oct 30, 2024

View reviewed changes

epage mentioned this pull request Nov 30, 2024

Publish Docker image crate-ci/committed#410

Open

epage mentioned this pull request Dec 16, 2024

feat(infra): Publish Docker image on release #1183

Open

		@@ -1,11 +1,82 @@
		ARG DEBIAN_DIST=bullseye
		# syntax=docker/dockerfile:1.10

		@@ -0,0 +1,219 @@
		# Build and Push Docker Image Workflow Documentation

		- GitHub Permissions: The `GITHUB_TOKEN` provided by GitHub Actions must have the necessary permissions (default settings typically suffice).
		- Understanding of Docker and GHCR: Basic knowledge of Docker image building and pushing to GHCR will be beneficial.

Conversation

georgettica commented Oct 8, 2024

Uh oh!

georgettica commented Oct 8, 2024

Uh oh!

georgettica commented Oct 8, 2024

Uh oh!

epage commented Oct 8, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

georgettica commented Oct 9, 2024

Uh oh!

georgettica commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

georgettica commented Oct 14, 2024

Uh oh!

weijiany commented Oct 15, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

georgettica commented Oct 15, 2024

Uh oh!

georgettica commented Oct 15, 2024

Uh oh!

weijiany commented Oct 15, 2024

Uh oh!

georgettica commented Oct 15, 2024

Uh oh!

georgettica commented Oct 21, 2024

Uh oh!

epage commented Oct 21, 2024

Uh oh!

georgettica commented Oct 22, 2024

Uh oh!

coveralls commented Oct 22, 2024

Pull Request Test Coverage Report for Build 11464483713

Details

💛 - Coveralls

Uh oh!

mjpieters commented Oct 25, 2024

Uh oh!

georgettica commented Oct 27, 2024

Uh oh!

georgettica commented Oct 27, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

georgettica commented Oct 14, 2024 •

edited

Loading