|
| 1 | +--- |
| 2 | +name: 'Checkout and use Build' |
| 3 | +description: 'checks-out the given commit and fetches the build artifact' |
| 4 | +author: 'Mr. Walls' |
| 5 | +branding: |
| 6 | + icon: 'chevron-down' |
| 7 | + color: 'blue' |
| 8 | +inputs: |
| 9 | + sha: |
| 10 | + description: | |
| 11 | + The commit to checkout and fetch build artifacts for. When running this action on github.com, |
| 12 | + the default value is sufficient. |
| 13 | + required: true |
| 14 | + default: ${{ github.server_url == 'https://github.com' && github.sha || 'HEAD' }} |
| 15 | + build-run-id: |
| 16 | + description: | |
| 17 | + The workflow run to fetch build artifacts from. When running this action on github.com, |
| 18 | + the default value is the calling workflow. |
| 19 | + required: true |
| 20 | + default: ${{ github.server_url == 'https://github.com' && github.run_id || '' }} |
| 21 | + path: |
| 22 | + description: | |
| 23 | + Path to setup. When running this action on github.com, the default value |
| 24 | + is sufficient. |
| 25 | + required: true |
| 26 | + default: ${{ github.server_url == 'https://github.com' && github.workspace || '' }} |
| 27 | + token: |
| 28 | + description: | |
| 29 | + The token used to authenticate when fetching Python distributions from |
| 30 | + https://github.com/actions/python-versions. When running this action on github.com, |
| 31 | + the default value is sufficient. When running on GHES, you can pass a personal access |
| 32 | + token for github.com if you are experiencing rate limiting. |
| 33 | + default: ${{ github.server_url == 'https://github.com' && github.token || '' }} |
| 34 | + required: true |
| 35 | + python-version: |
| 36 | + description: | |
| 37 | + The python version to setup. The default is to use the value of the environment |
| 38 | + variable 'PYTHON_VERSION'. |
| 39 | + default: '3.12' |
| 40 | + required: true |
| 41 | +outputs: |
| 42 | + branch-name: |
| 43 | + description: "The name of the branch that was checked-out" |
| 44 | + value: ${{ steps.output_branch_name.outputs.branch-name || '' }} |
| 45 | + sha: |
| 46 | + description: "The SHA of the commit checked-out" |
| 47 | + value: ${{ steps.output_sha.outputs.sha || 'HEAD' }} |
| 48 | + python-version: |
| 49 | + description: "The python version that was used in the run." |
| 50 | + value: ${{ steps.cp313.outputs.python-version || '' }} |
| 51 | + artifact-name: |
| 52 | + description: "The downloaded artifact-name" |
| 53 | + value: "multicast-build-${{ steps.output_sha.outputs.sha }}.zip" |
| 54 | + artifact-files: |
| 55 | + description: "The downloaded artifact-files" |
| 56 | + value: ${{ steps.output_artifact_files.outputs.files }} |
| 57 | + |
| 58 | +runs: |
| 59 | + using: composite |
| 60 | + steps: |
| 61 | + - name: Checkout repository |
| 62 | + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 |
| 63 | + with: |
| 64 | + persist-credentials: false |
| 65 | + fetch-depth: 0 |
| 66 | + path: ${{ inputs.path }} |
| 67 | + repository: reactive-firewall/multicast |
| 68 | + token: ${{ inputs.token }} |
| 69 | + - name: "Checkout Target Commit by SHA" |
| 70 | + shell: bash |
| 71 | + run: | |
| 72 | + printf "%s\n" "::group::target-commit" |
| 73 | + git checkout --force --detach ${{ inputs.sha }} -- |
| 74 | + printf "%s\n" "::endgroup::" |
| 75 | + if: ${{ (github.sha != inputs.sha) && success() }} |
| 76 | + - id: output_branch_name |
| 77 | + if: ${{ !cancelled() }} |
| 78 | + shell: bash |
| 79 | + run: | |
| 80 | + printf "branch-name=%s\n" $(git name-rev --name-only HEAD | cut -d~ -f1-1) >> "$GITHUB_OUTPUT" |
| 81 | + - id: output_sha |
| 82 | + shell: bash |
| 83 | + run: printf "sha=%s\n" $(git rev-parse --verify HEAD) >> "$GITHUB_OUTPUT" |
| 84 | + - name: "Setup Python" |
| 85 | + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 |
| 86 | + id: cp313 |
| 87 | + with: |
| 88 | + python-version: ${{ inputs.python-version }} |
| 89 | + cache: 'pip' # caching pip dependencies |
| 90 | + if: ${{ !cancelled() }} |
| 91 | + - name: "Install Test Dependencies" |
| 92 | + shell: bash |
| 93 | + run: make -j1 -f Makefile test-reqs ; |
| 94 | + - id: output_artifact_name |
| 95 | + if: ${{ success() }} |
| 96 | + shell: bash |
| 97 | + run: printf "artifact-name=%s\n" multicast-build-${{ steps.output_sha.outputs.sha }}.zip >> "$GITHUB_OUTPUT" |
| 98 | + - name: "Fetch Build Files" |
| 99 | + if: ${{ (github.repository == 'reactive-firewall/multicast') && success() }} |
| 100 | + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 |
| 101 | + with: |
| 102 | + path: ${{ inputs.path }}/dist |
| 103 | + pattern: multicast-build-${{ steps.output_sha.outputs.sha }}.zip |
| 104 | + merge-multiple: true |
| 105 | + repository: reactive-firewall/multicast |
| 106 | + github-token: ${{ inputs.token }} |
| 107 | + run-id: ${{ inputs.build-run-id }} |
| 108 | + - name: "Enumerate Fetched Files" |
| 109 | + id: output_artifact_files |
| 110 | + env: |
| 111 | + BUILD_MATCH_PATTERN: "dist/multicast-*-*.whl dist/multicast-*.tar.gz" |
| 112 | + SCRIPT_NAME: ".github/actions/checkout-and-rebuild/action.yml" |
| 113 | + shell: bash |
| 114 | + run: | |
| 115 | + FILES=$(git ls-files -oi --exclude-standard -- ${{ env.BUILD_MATCH_PATTERN }} ) |
| 116 | + if [ -z "$FILES" ]; then |
| 117 | + printf "::warning file=%s:: %s\n" "${SCRIPT_NAME}" "No Built files found." |
| 118 | + printf "%s\n" "files=" >> "$GITHUB_OUTPUT" |
| 119 | + else |
| 120 | + printf "%s\n" "Built files found:" |
| 121 | + printf "%s\n" "$FILES" |
| 122 | + # Replace line breaks with commas for GitHub Action Output |
| 123 | + FILES="${FILES//$'\n'/ }" |
| 124 | + printf "%s\n" "files=$FILES" >> "$GITHUB_OUTPUT" |
| 125 | + fi |
| 126 | + if: ${{ success() }} |
0 commit comments