03 Maintain: Update Package Cache #137
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
| name: "03 Maintain: Update Package Cache" | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| name: | |
| description: 'Who triggered this build (enter github username to tag yourself)?' | |
| required: true | |
| default: 'monthly run' | |
| schedule: | |
| # Run every tuesday | |
| - cron: '0 0 * * 2' | |
| jobs: | |
| preflight: | |
| name: "Preflight Check" | |
| runs-on: ubuntu-latest | |
| outputs: | |
| ok: ${{ steps.check.outputs.ok }} | |
| steps: | |
| - id: check | |
| run: | | |
| if [[ ${{ github.event_name }} == 'workflow_dispatch' ]]; then | |
| echo "::set-output name=ok::true" | |
| echo "Running on request" | |
| # using single brackets here to avoid 08 being interpreted as octal | |
| # https://github.com/carpentries/sandpaper/issues/250 | |
| elif [ `date +%d` -le 7 ]; then | |
| # If the Tuesday lands in the first week of the month, run it | |
| echo "::set-output name=ok::true" | |
| echo "Running on schedule" | |
| else | |
| echo "::set-output name=ok::false" | |
| echo "Not Running Today" | |
| fi | |
| check_renv: | |
| name: "Check if We Need {renv}" | |
| runs-on: ubuntu-latest | |
| needs: preflight | |
| if: ${{ needs.preflight.outputs.ok == 'true'}} | |
| outputs: | |
| needed: ${{ steps.renv.outputs.exists }} | |
| steps: | |
| - name: "Checkout Lesson" | |
| uses: actions/checkout@v2 | |
| - id: renv | |
| run: | | |
| if [[ -d renv ]]; then | |
| echo "::set-output name=exists::true" | |
| fi | |
| check_token: | |
| name: "Check SANDPAPER_WORKFLOW token" | |
| runs-on: ubuntu-latest | |
| needs: check_renv | |
| if: ${{ needs.check_renv.outputs.needed == 'true' }} | |
| outputs: | |
| workflow: ${{ steps.validate.outputs.wf }} | |
| repo: ${{ steps.validate.outputs.repo }} | |
| steps: | |
| - name: "validate token" | |
| id: validate | |
| uses: carpentries/actions/check-valid-credentials@main | |
| with: | |
| token: ${{ secrets.SANDPAPER_WORKFLOW }} | |
| bad_token: | |
| name: "Invalid/Missing Token" | |
| runs-on: ubuntu-latest | |
| needs: check_token | |
| if: ${{ needs.check_token.outputs.workflow != 'true' }} | |
| steps: | |
| - name: "Instructions to create a new token" | |
| run: | | |
| printf "::warning::The SANDPAPER_WORKFLOW secret is missing, invalid, "\ | |
| "or does not have the right scope to update the package cache.\n"\ | |
| "If you want to have automated pull request updates to your package cache, "\ | |
| "you will need to generate a new token by visiting "\ | |
| "https://github.com/settings/tokens/new?scopes=repo,workflow&description=Sandpaper%%20Token%%20%%28${{ github.repository }}%%29\n"\ | |
| "Once you have created the token, copy it to your clipboard and go to "\ | |
| "https://github.com/${{ github.repository }}/settings/secrets/actions/new "\ | |
| "and enter SANDPAPER_WORKFLOW for the 'Name' and paste your key for the 'Value'." | |
| update_cache: | |
| name: "Update Package Cache" | |
| needs: check_token | |
| if: ${{ needs.check_token.outputs.repo== 'true' }} | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
| RENV_PATHS_ROOT: ~/.local/share/renv/ | |
| steps: | |
| - name: "Checkout Lesson" | |
| uses: actions/checkout@v2 | |
| - name: "Set up R" | |
| uses: r-lib/actions/setup-r@v2 | |
| with: | |
| use-public-rspm: true | |
| install-r: false | |
| - name: "Update {renv} deps and determine if a PR is needed" | |
| id: update | |
| uses: carpentries/actions/update-lockfile@main | |
| with: | |
| cache-version: ${{ secrets.CACHE_VERSION }} | |
| - name: Create Pull Request | |
| id: cpr | |
| if: ${{ steps.update.outputs.n > 0 }} | |
| uses: peter-evans/create-pull-request@v3.10.0 | |
| with: | |
| token: ${{ secrets.SANDPAPER_WORKFLOW }} | |
| delete-branch: true | |
| branch: "update-${{ steps.update.outputs.n }}-packages-${{ steps.update.outputs.date }}" | |
| commit-message: "[actions] update ${{ steps.update.outputs.n }} packages" | |
| title: "Update ${{ steps.update.outputs.n }} packages" | |
| body: | | |
| :robot: This is an automated build | |
| This will update the following package versions in your lesson: | |
| ``` | |
| ${{ steps.update.outputs.report }} | |
| ``` | |
| :stopwatch: In a few minutes, a comment will appear that will show you how the output has changed based on these updates. | |
| If you want to inspect these changes locally, you can use the following code to check out a new branch: | |
| ```bash | |
| git fetch origin update-${{ steps.update.outputs.n }}-packages-${{ steps.update.outputs.date }} | |
| git checkout update-${{ steps.update.outputs.n }}-packages-${{ steps.update.outputs.date }} | |
| ``` | |
| - Auto-generated by [create-pull-request][1] via ${{ github.event.inputs.name }} | |
| [1]: https://github.com/peter-evans/create-pull-request | |
| labels: "type:package cache" | |
| draft: false |