-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: workflow to update actions dist (#3653)
# Summary Similar to slsa-verifier's slsa-framework/slsa-verifier#760 This PR adds a manually-invoked workflow to run against renovate-bot's PRs to update the node `dist` folders. I made one small change to use the `${{ inputs.pr_number }} ` as an environment variable, to harden against [script injection](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#good-practices-for-mitigating-script-injection-attacks). See also slsa-framework/slsa-verifier#771 Also updating shellckeck to fix this lint error: - https://github.com/slsa-framework/slsa-github-generator/actions/runs/9101693389/job/25019502486#step:4:21 ``` Error: input type of workflow_dispatch event must be one of "string", "boolean", "choice", "environment" but got "number" ``` ## Testing Process I ran this against my fork's version of PR #3649. It did update the dist folders and the check-dists checks pass - https://github.com/ramonpetgrave64/slsa-github-generator/actions/runs/9101190828/job/25017786420?pr=9 - https://github.com/slsa-framework/slsa-verifier/pull/760/files#diff-4c6b93aa75d5affde60dc3849606c9acd75ed444d52e99f3055fc0c7aa77e9e0 ## Checklist - [x] Review the contributing [guidelines](https://github.com/slsa-framework/slsa-github-generator/blob/main/CONTRIBUTING.md) - [ ] Add a reference to related issues in the PR description. - [x] Update documentation if applicable. - [ ] Add unit tests if applicable. - [ ] Add changes to the [CHANGELOG](https://github.com/slsa-framework/slsa-github-generator/blob/main/CHANGELOG.md) if applicable. --------- Signed-off-by: Ramon Petgrave <[email protected]>
- Loading branch information
1 parent
89cdf20
commit 75daab2
Showing
3 changed files
with
143 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # Copyright 2023 SLSA Authors | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| # A workflow to run against renovate-bot's PRs, | ||
| # such as `make package` after it updates the package.json and package-lock.json files. | ||
|
|
||
| # The potentially untrusted code is first run inside a low-privilege Job, and the diff is uploaded as an artifact. | ||
| # Then a higher-privilege Job applies the diff and pushes the changes to the PR. | ||
| # It's important to only run this workflow against PRs from trusted sources, after also reviewing the changes! | ||
|
|
||
| # There have been vulnerabilities with using `git apply` https://github.blog/2023-04-25-git-security-vulnerabilities-announced-4/ | ||
| # At this point a compromised git binary cannot modify any of this repo's branches, only the PR fork's branch, | ||
| # due to our branch protection rules and CODEOWNERS. | ||
| # It aslso cannot submit a new release or modify exsiting releases due to tag protection rules. | ||
|
|
||
| name: Update actions dist post-commit | ||
|
|
||
| permissions: {} | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| pr_number: | ||
| description: "The pull request number." | ||
| required: true | ||
| type: number | ||
|
|
||
| jobs: | ||
| diff: | ||
| permissions: | ||
| # This Job executes the PR's untrusted code, so it must how low permissions. | ||
| pull-requests: read | ||
| outputs: | ||
| patch_not_empty: ${{ steps.diff.outputs.patch_not_empty }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: checkout | ||
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
| with: | ||
| repository: ${{ github.repository }} | ||
| persist-credentials: false | ||
| - name: checkout-pr | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| PR_NUMBER: ${{ inputs.pr_number }} | ||
| run: gh pr checkout "$PR_NUMBER" | ||
| - name: run-command | ||
| run: | | ||
| find ./ -name "dist" -not -path "*/node_modules/*" -print0 \ | ||
| | xargs -0 dirname \ | ||
| | xargs -I {} sh -c '( | ||
| echo "Updating {}" && \ | ||
| cd {} && \ | ||
| make clean \ | ||
| && make package | ||
| )' | ||
| - name: diff | ||
| id: diff | ||
| run: | | ||
| git add . | ||
| git status | ||
| git diff HEAD > changes.patch | ||
| [ -z "$(cat changes.patch)" ] && RESULT=false || RESULT=true | ||
| echo "patch_not_empty=$RESULT" >> "$GITHUB_OUTPUT" | ||
| - name: upload | ||
| uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 | ||
| with: | ||
| name: changes.patch | ||
| path: changes.patch | ||
|
|
||
| push: | ||
| if: needs.diff.outputs.patch_not_empty == 'true' | ||
| needs: diff | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| # This Job does not run untrusted code, but it does need to push changes to the PR's branch. | ||
| pull-requests: read | ||
| contents: write | ||
| steps: | ||
| - name: checkout | ||
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
| - name: checkout-pr | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| PR_NUMBER: ${{ inputs.pr_number }} | ||
| run: gh pr checkout "$PR_NUMBER" | ||
| - name: download-patch | ||
| uses: actions/download-artifact@c850b930e6ba138125429b7e5c93fc707a7f8427 # v4.1.4 | ||
| with: | ||
| name: changes.patch | ||
| - id: apply | ||
| run: | | ||
| git apply changes.patch | ||
| rm changes.patch | ||
| # example from | ||
| # https://github.com/actions/checkout/blob/cd7d8d697e10461458bc61a30d094dc601a8b017/README.md#push-a-commit-using-the-built-in-token | ||
| - name: push | ||
| run: | | ||
| git config user.name github-actions | ||
| git config user.email [email protected] | ||
| git add . | ||
| git status | ||
| git commit -s -m "update actions dist" | ||
| git push |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters