feat: allows overwriting the default branch of a repository (#114)

input-output-hk · Nov 30, 2023 · c2f7d03 · c2f7d03
1 parent b9f4695
commit c2f7d03
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 6 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,6 +24,12 @@ on:
         required: false
         type: string
         default: latest
+      default_branch:
+        description: |
+          The default branch of the repository.
+        required: false
+        type: string
+        default: ${{ github.event.repository.default_branch }}
       deployment_images:
         description: A newline separated list of image names to deploy
         required: false
@@ -160,6 +166,7 @@ jobs:
       aws_role_arn: ${{ inputs.aws_role_arn }}
       aws_region: ${{ inputs.aws_region }}
       ci_cli_version: ${{ inputs.ci_cli_version }}
+      default_branch: ${{ inputs.default_branch }}
       earthly_version: ${{ inputs.earthly_version }}
       skip_publish_on_default: ${{ inputs.skip_publish_on_default }}
       tags: ${{ inputs.tags }}

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -35,6 +35,12 @@ on:
         required: false
         type: string
         default: latest
+      default_branch:
+        description: |
+          The default branch of the repository.
+        required: false
+        type: string
+        default: ${{ github.event.repository.default_branch }}
       earthly_version:
         description: The version of Earthly to use.
         required: false
@@ -134,7 +140,7 @@ jobs:
           runner_address: ${{ secrets.earthly_runner_address }}
       - name: Push image
         uses: input-output-hk/catalyst-ci/actions/push@master
-        if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && !inputs.skip_publish_on_default
+        if: github.ref == format('refs/heads/{0}', inputs.default_branch) && !inputs.skip_publish_on_default
         with:
           image: ${{ steps.build.outputs.image }}
           registries: |

diff --git a/docs/src/reference/workflows.md b/docs/src/reference/workflows.md
@@ -94,11 +94,12 @@ It then uses the custom `push` GitHub Action to re-tag the image and push it to
 
 ### Inputs
 
-| Name             | Type   | Description                                                                        | Required | Default   |
-| ---------------- | ------ | ---------------------------------------------------------------------------------- | -------- | --------- |
-| target           | string | The target used to mark check builds                                               | No       | `publish` |
-| aws_ecr_registry | string | The AWS ECR registry that will be used to publish images                           | No       | `""`      |
-| tags             | string | A line separated list of additional tags that will be applied to published images. | No       | `""`      |
+| Name             | Type   | Description                                                                        | Required | Default                                         |
+| ---------------- | ------ | ---------------------------------------------------------------------------------- | -------- | ----------------------------------------------- |
+| aws_ecr_registry | string | The AWS ECR registry that will be used to publish images                           | No       | `""`                                            |
+| default_branch   | string | The default branch of the repository.                                              | No       | `${{ github.event.repository.default_branch }}` |
+| tags             | string | A line separated list of additional tags that will be applied to published images. | No       | `""`                                            |
+| target           | string | The target used to mark check builds                                               | No       | `publish`                                       |
 
 ## Release