From 7383d3e0802eb53dc04e219254e1341996e5a08c Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 17:52:19 +0200 Subject: [PATCH 1/7] removed master from branches, added PRs --- .github/workflows/publishBranches.yml | 5 ++- .github/workflows/publishPRs.yml | 52 +++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/publishPRs.yml diff --git a/.github/workflows/publishBranches.yml b/.github/workflows/publishBranches.yml index ea4646b..195d2d4 100644 --- a/.github/workflows/publishBranches.yml +++ b/.github/workflows/publishBranches.yml @@ -3,7 +3,10 @@ name: Create and publish a Docker image on a branch # Configures this workflow to run every time a change is pushed to the branch called `master`. on: - push + push: + branches: + - '*' + - '!master' # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. env: diff --git a/.github/workflows/publishPRs.yml b/.github/workflows/publishPRs.yml new file mode 100644 index 0000000..d20757b --- /dev/null +++ b/.github/workflows/publishPRs.yml @@ -0,0 +1,52 @@ +# +name: Create and publish a Docker image on a branch + +# Configures this workflow to run every time a change is pushed to the branch called `master`. +on: + pull_request: + +# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. +jobs: + build-and-push-image: + runs-on: ubuntu-latest + # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. + permissions: + contents: read + packages: write + # + steps: + - name: Checkout repository + uses: actions/checkout@v3 + # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. + - name: Log in to the Container registry + uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. + - name: Extract branch name + shell: bash + run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT + id: extract_branch + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: ${{ steps.extract_branch.outputs.branch }} + # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. + # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. + # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. + - name: Build and push Docker image + uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} From c7fd1e6772d912d1a676ffd1ec831fd979c235f3 Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 17:54:57 +0200 Subject: [PATCH 2/7] merged branches and PRs into one workflow --- ...ishBranches.yml => publishBranchesPRs.yml} | 1 + .github/workflows/publishPRs.yml | 52 ------------------- 2 files changed, 1 insertion(+), 52 deletions(-) rename .github/workflows/{publishBranches.yml => publishBranchesPRs.yml} (99%) delete mode 100644 .github/workflows/publishPRs.yml diff --git a/.github/workflows/publishBranches.yml b/.github/workflows/publishBranchesPRs.yml similarity index 99% rename from .github/workflows/publishBranches.yml rename to .github/workflows/publishBranchesPRs.yml index 195d2d4..4042baf 100644 --- a/.github/workflows/publishBranches.yml +++ b/.github/workflows/publishBranchesPRs.yml @@ -3,6 +3,7 @@ name: Create and publish a Docker image on a branch # Configures this workflow to run every time a change is pushed to the branch called `master`. on: + pull_request push: branches: - '*' diff --git a/.github/workflows/publishPRs.yml b/.github/workflows/publishPRs.yml deleted file mode 100644 index d20757b..0000000 --- a/.github/workflows/publishPRs.yml +++ /dev/null @@ -1,52 +0,0 @@ -# -name: Create and publish a Docker image on a branch - -# Configures this workflow to run every time a change is pushed to the branch called `master`. -on: - pull_request: - -# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. -env: - REGISTRY: ghcr.io - IMAGE_NAME: ${{ github.repository }} - -# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. -jobs: - build-and-push-image: - runs-on: ubuntu-latest - # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. - permissions: - contents: read - packages: write - # - steps: - - name: Checkout repository - uses: actions/checkout@v3 - # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. - - name: Log in to the Container registry - uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. - - name: Extract branch name - shell: bash - run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT - id: extract_branch - - name: Extract metadata (tags, labels) for Docker - id: meta - uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 - with: - images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - tags: ${{ steps.extract_branch.outputs.branch }} - # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. - # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. - # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. - - name: Build and push Docker image - uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 - with: - context: . - push: true - tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} From 25f60ce1dc192bc557d4199f79956678ac584db3 Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 19:21:04 +0200 Subject: [PATCH 3/7] fixed syntax error --- .github/workflows/publishBranchesPRs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publishBranchesPRs.yml b/.github/workflows/publishBranchesPRs.yml index 4042baf..42912db 100644 --- a/.github/workflows/publishBranchesPRs.yml +++ b/.github/workflows/publishBranchesPRs.yml @@ -1,9 +1,9 @@ # name: Create and publish a Docker image on a branch -# Configures this workflow to run every time a change is pushed to the branch called `master`. +# Configures this workflow to run every time a change is pushed to any branch not called `master` and on PR event. on: - pull_request + pull_request: push: branches: - '*' From 4a9be2781da608abdda60c8651d6dece278cd2ae Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 19:25:04 +0200 Subject: [PATCH 4/7] removed branch builds, use PR instead, avoids double builds --- .github/workflows/publish.yml | 2 +- .github/workflows/publishBranchesPRs.yml | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index e5082cf..2d11974 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,5 +1,5 @@ # -name: Create and publish a Docker image on master +name: Master: Create and publish a Docker image # Configures this workflow to run every time a change is pushed to the branch called `master`. on: diff --git a/.github/workflows/publishBranchesPRs.yml b/.github/workflows/publishBranchesPRs.yml index 42912db..11ddba7 100644 --- a/.github/workflows/publishBranchesPRs.yml +++ b/.github/workflows/publishBranchesPRs.yml @@ -1,13 +1,13 @@ # -name: Create and publish a Docker image on a branch +name: PR: Create and publish a Docker image -# Configures this workflow to run every time a change is pushed to any branch not called `master` and on PR event. +# Build when a PR is created on: pull_request: - push: - branches: - - '*' - - '!master' + #push: + # branches: + # - '*' + # - '!master' # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. env: From fba33636711c43f69a51e08f61bd9e541667d0bf Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 19:25:47 +0200 Subject: [PATCH 5/7] fixed syntax error --- .github/workflows/publish.yml | 2 +- .github/workflows/publishBranchesPRs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 2d11974..8abddac 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,5 +1,5 @@ # -name: Master: Create and publish a Docker image +name: Master - Create and publish a Docker image # Configures this workflow to run every time a change is pushed to the branch called `master`. on: diff --git a/.github/workflows/publishBranchesPRs.yml b/.github/workflows/publishBranchesPRs.yml index 11ddba7..09148d8 100644 --- a/.github/workflows/publishBranchesPRs.yml +++ b/.github/workflows/publishBranchesPRs.yml @@ -1,5 +1,5 @@ # -name: PR: Create and publish a Docker image +name: PR - Create and publish a Docker image # Build when a PR is created on: From 04994c4343e44fde3028ebf616d15143ab2cb609 Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 19:39:32 +0200 Subject: [PATCH 6/7] added separate tag publishing for correc image labeling --- .github/workflows/publishTags.yml | 54 +++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/workflows/publishTags.yml diff --git a/.github/workflows/publishTags.yml b/.github/workflows/publishTags.yml new file mode 100644 index 0000000..26cbb5f --- /dev/null +++ b/.github/workflows/publishTags.yml @@ -0,0 +1,54 @@ +# +name: PR - Create and publish a Docker image + +# Build when a tag is created +on: + push: + tags: + - '**' + +# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. +jobs: + build-and-push-image: + runs-on: ubuntu-latest + # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. + permissions: + contents: read + packages: write + # + steps: + - name: Checkout repository + uses: actions/checkout@v3 + # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. + - name: Log in to the Container registry + uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. + - name: Extract branch name + shell: bash + run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT + id: extract_branch + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: ${{ github.ref_name }} + # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. + # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. + # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. + - name: Build and push Docker image + uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} From d35ebd2bfdbbcff615363dd99414868dc12d5e73 Mon Sep 17 00:00:00 2001 From: Philipp Mundhenk Date: Mon, 23 Sep 2024 19:41:29 +0200 Subject: [PATCH 7/7] fixed naming --- .github/workflows/{publish.yml => publishMaster.yml} | 0 .github/workflows/publishTags.yml | 6 +----- 2 files changed, 1 insertion(+), 5 deletions(-) rename .github/workflows/{publish.yml => publishMaster.yml} (100%) diff --git a/.github/workflows/publish.yml b/.github/workflows/publishMaster.yml similarity index 100% rename from .github/workflows/publish.yml rename to .github/workflows/publishMaster.yml diff --git a/.github/workflows/publishTags.yml b/.github/workflows/publishTags.yml index 26cbb5f..4dd9245 100644 --- a/.github/workflows/publishTags.yml +++ b/.github/workflows/publishTags.yml @@ -1,5 +1,5 @@ # -name: PR - Create and publish a Docker image +name: Tags - Create and publish a Docker image # Build when a tag is created on: @@ -32,10 +32,6 @@ jobs: username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. - - name: Extract branch name - shell: bash - run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT - id: extract_branch - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7