You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
run-circleci-artifacts-redirector
0.2.0
GitHub Action to add a GitHub status link to a CircleCI artifact.
Sample .github/workflows/main.yml
:
on: [status]
jobs:
circleci_artifacts_redirector_job:
runs-on: ubuntu-latest
name: Run CircleCI artifacts redirector
steps:
- name: GitHub Action step
id: step1
uses: larsoner/circleci-artifacts-redirector-action@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
artifact-path: 0/test_artifacts/root_artifact.md
circleci-jobs: build_doc
- name: Check the URL
run: |
curl --fail ${{ steps.step1.outputs.url }} | grep $GITHUB_SHA
- The
artifact-path
should point to an artifact path from your CircleCI build. This is typically whatever follows the CircleCI artifact root path, for example0/test_artifacts/root_artifact.md
. - The
circleci-jobs
is a comma-separated list of jobs to monitor, but usually there is a single one that you want an artifact path for. The default is"build_docs,build,doc"
, which will look for any jobs with these names and create an artifacts link for them. - If you have trouble, try enabling debugging logging
for the action by setting the secret
ACTIONS_STEP_DEBUG=true
.
Note: The standard PR-to-main-repo-from-branch-in-a-fork workflow might not activate the action. For changes to take effect, changes might need to be made to to the default branch in a repo with the action enabled. For example, you could iterate directly in
master
, or inmaster
of a fork. This seems to be a limitation of the fact that CircleCI uses thestatus
(rather than app) API and that this is always tied to themaster
/default branch of a given repository.
Currently has (known) limitations:
- Tests do not test anything (haven't gotten around to fixing them)
- Only allows redirecting to a single file that must be configured ahead of time as a file (cannot be changed within the CircleCI run)
Eventually this might be fixable by a bit of work and addition of customization options.