Automatic Update from package template #21
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 template is taken from the cruft example code, for further information please see: | |
| # https://cruft.github.io/cruft/#automating-updates-with-github-actions | |
| name: Automatic Update from package template | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| on: | |
| # Allow manual runs through the web UI | |
| workflow_dispatch: | |
| schedule: | |
| # ┌───────── minute (0 - 59) | |
| # │ ┌───────── hour (0 - 23) | |
| # │ │ ┌───────── day of the month (1 - 31) | |
| # │ │ │ ┌───────── month (1 - 12 or JAN-DEC) | |
| # │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT) | |
| - cron: '0 7 * * 1' # Every Monday at 7am UTC | |
| jobs: | |
| update: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| include: | |
| - add-paths: . | |
| body: apply the changes to this repo. | |
| branch: cruft/update | |
| commit-message: "Automatic package template update" | |
| title: Updates from the package template | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install Cruft | |
| run: python -m pip install git+https://github.com/Cadair/cruft@patch-p1 | |
| - name: Check if update is available | |
| continue-on-error: false | |
| id: check | |
| run: | | |
| CHANGES=0 | |
| if [ -f .cruft.json ]; then | |
| if ! cruft check; then | |
| CHANGES=1 | |
| fi | |
| else | |
| echo "No .cruft.json file" | |
| fi | |
| echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT" | |
| - name: Run update if available | |
| if: steps.check.outputs.has_changes == '1' | |
| run: | | |
| git config --global user.email "${{ github.actor }}@users.noreply.github.com" | |
| git config --global user.name "${{ github.actor }}" | |
| cruft update --skip-apply-ask --refresh-private-variables | |
| git restore --staged . | |
| - name: Create pull request | |
| if: steps.check.outputs.has_changes == '1' | |
| uses: peter-evans/create-pull-request@v7 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| add-paths: ${{ matrix.add-paths }} | |
| commit-message: ${{ matrix.commit-message }} | |
| branch: ${{ matrix.branch }} | |
| delete-branch: true | |
| branch-suffix: timestamp | |
| title: ${{ matrix.title }} | |
| body: | | |
| This is an autogenerated PR, which will ${{ matrix.body }}. | |
| [Cruft](https://cruft.github.io/cruft/) has detected updates from the Package Template |