add documentation to workflow files #1
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: Update depencies in poetry lockfile | |
| on: | |
| schedule: | |
| - cron: '0 1 * * 1' | |
| workflow_dispatch: | |
| push: | |
| branches: main | |
| paths: | |
| - .github/workflows/update_dependencies.yml | |
| jobs: | |
| update_dependencies: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out repo and set up Python | |
| - uses: actions/checkout@v3 | |
| with: | |
| lfs: true | |
| # see https://stackoverflow.com/questions/57612428/cloning-private-github-repository-within-organisation-in-actions | |
| - name: checkout test data | |
| run: | | |
| eval `ssh-agent -s` | |
| ssh-add - <<< '${{ secrets.TEST_DATA_ACCESS_KEY }}' | |
| git submodule sync --recursive | |
| git submodule update --init --recursive | |
| # see https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md | |
| - uses: tibdex/github-app-token@v1 | |
| id: generate-token | |
| with: | |
| app_id: ${{ secrets.APP_ID }} | |
| private_key: ${{ secrets.APP_PRIVATE_KEY }} | |
| # Use cached python and dependencies, install poetry | |
| - name: "Setup Python, Poetry and Dependencies" | |
| uses: packetcoders/action-setup-cache-python-poetry@main | |
| with: | |
| python-version: 3.8 | |
| poetry-version: 1.2.2 | |
| # update poetry lockfile | |
| - name: "Update poetry lock file" | |
| id: update | |
| run: | | |
| poetry self update | |
| exec 5>&1 | |
| UPDATE_OUTPUT=$(poetry update|tee >(cat - >&5)) | |
| echo "UPDATE_OUTPUT<<EOF" >> $GITHUB_OUTPUT | |
| echo "$UPDATE_OUTPUT" >> $GITHUB_OUTPUT | |
| echo "EOF" >> $GITHUB_OUTPUT | |
| - name: Obtain git status | |
| id: status | |
| run: | | |
| exec 5>&1 | |
| STATUS=$(git status|tee >(cat - >&5)) | |
| echo "STATUS<<EOF" >> $GITHUB_OUTPUT | |
| echo "$STATUS" >> $GITHUB_OUTPUT | |
| echo "EOF" >> $GITHUB_OUTPUT | |
| # create pull request if necessary | |
| - name: "Create Pull Request" | |
| uses: peter-evans/create-pull-request@v5 | |
| if: ${{ contains(steps.status.outputs.STATUS, 'poetry.lock')}} | |
| with: | |
| token: ${{ steps.generate-token.outputs.token }} | |
| commit-message: Update dependencies | |
| title: "Update dependencies" | |
| body: | | |
| Dependency updates using Poetry: | |
| ${{ steps.update.outputs.UPDATE_OUTPUT }} |