Merge 8a35517545 into 218af422c0

Merge pull request #305 from trail-of-forks/ww/debug-workflow-ref
oidc-exchange: add workflow_ref to debug msg
2024-11-30 21:22:28 +08:00 · 2024-11-26 00:31:22 +01:00 · 2024-11-24 03:01:28 +01:00 · 2024-11-22 12:58:46 -05:00 · 2024-11-11 22:43:13 -05:00
2 changed files with 20 additions and 2 deletions
--- a/action.yml
+++ b/action.yml
@ -87,6 +87,20 @@ inputs:
      Only works with PyPI and TestPyPI via Trusted Publishing.
    required: false
    default: 'true'
+  action_repository:
+    description: >-
+      [EXPERIMENTAL]
+      Set action repository to work around bug in nested composite actions
+      https://github.com/actions/runner/issues/2473
+    required: false
+    default: ${{ github.action_repository }}
+  action_ref:
+    description: >-
+      [EXPERIMENTAL]
+      Set action ref to work around bug in nested composite actions
+      https://github.com/actions/runner/issues/2473
+    required: false
+    default: ${{ github.action_ref }}
 branding:
  color: yellow
  icon: upload-cloud
@ -116,17 +130,19 @@ runs:
    run: |
      # Set repo and ref from which to run Docker container action
      # to handle cases in which `github.action_` context is not set
+      # or set properly for nested composite actions
      # https://github.com/actions/runner/issues/2473
      REF=${{ env.ACTION_REF || env.PR_REF || github.ref_name }}
      REPO=${{ env.ACTION_REPO || env.PR_REPO || github.repository }}
      REPO_ID=${{ env.PR_REPO_ID || github.repository_id }}
+      echo "action-path=$ACTION_PATH" >>"$GITHUB_OUTPUT"
      echo "ref=$REF" >>"$GITHUB_OUTPUT"
      echo "repo=$REPO" >>"$GITHUB_OUTPUT"
      echo "repo-id=$REPO_ID" >>"$GITHUB_OUTPUT"
    shell: bash
    env:
-      ACTION_REF: ${{ github.action_ref }}
-      ACTION_REPO: ${{ github.action_repository }}
+      ACTION_REF: ${{ inputs.action_ref }}
+      ACTION_REPO: ${{ inputs.action_repository }}
      PR_REF: ${{ github.event.pull_request.head.ref }}
      PR_REPO: ${{ github.event.pull_request.head.repo.full_name }}
      PR_REPO_ID: ${{ github.event.pull_request.base.repo.id }}
--- a/oidc-exchange.py
+++ b/oidc-exchange.py
@ -83,6 +83,7 @@ If a claim is not present in the claim set, then it is rendered as `MISSING`.
 * `repository`: `{repository}`
 * `repository_owner`: `{repository_owner}`
 * `repository_owner_id`: `{repository_owner_id}`
+* `workflow_ref`: `{workflow_ref}`
 * `job_workflow_ref`: `{job_workflow_ref}`
 * `ref`: `{ref}`

@ -175,6 +176,7 @@ def render_claims(token: str) -> str:
        repository=_get('repository'),
        repository_owner=_get('repository_owner'),
        repository_owner_id=_get('repository_owner_id'),
+        workflow_ref=_get('workflow_ref'),
        job_workflow_ref=_get('job_workflow_ref'),
        ref=_get('ref'),
    )
Author	SHA1	Message	Date
Brendon Smith	2264806ebf	Merge `8a35517545` into `218af422c0`	2024-11-26 00:31:22 +01:00
🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко)	218af422c0	Merge pull request #305 from trail-of-forks/ww/debug-workflow-ref	2024-11-24 03:01:28 +01:00
William Woodruff	7c5c585c36	oidc-exchange: add workflow_ref to debug msg Signed-off-by: William Woodruff <william@trailofbits.com>	2024-11-22 12:58:46 -05:00
Brendon Smith	8a35517545	Support nested composite actions To reference metadata about composite actions, GitHub Actions provides the `github.action_` context, including `github.action_path`, `github.action_ref`, and `github.action_repository`. GitHub Actions supports nested composite actions with a recursion limit of 9 (9 nested composite actions). Unfortunately `github.action_` values are not propagated correctly when running nested composite actions. This is a bug in the GitHub Actions runner. The suggested workaround is to use inputs to set the correct values. This commit will implement the suggested workaround. https://docs.github.com/en/actions/creating-actions/creating-a-composite-action https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context https://github.com/actions/runner/issues/2473#issuecomment-1776029708 https://github.com/pypa/gh-action-pypi-publish/issues/299	2024-11-11 22:43:13 -05:00