Claudie v0.8.0 #21
Workflow file for this run
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: Release docs pipeline | |
| on: | |
| # Run when release is published | |
| release: | |
| types: [published] | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| pull-requests: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build-and-publish: | |
| name: Create a new docs release | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.head_ref }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Set release tag | |
| run: | | |
| R=${GITHUB_REF#"refs/tags/"} | |
| echo "RELEASE=$R" >> $GITHUB_ENV | |
| - name: Set up git author | |
| run: | | |
| git config --global user.name "${GITHUB_ACTOR}" | |
| git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Handle Changelog file | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| filename="mkdocs.yml" | |
| start_line=$(sed -n '/- Changelog:/=' "$filename") | |
| changelogs_from_dir=$(ls ./docs/CHANGELOG) | |
| changelogs_from_mkdocs_file=$(grep -Eo "CHANGELOG/changelog-[0-9]+\.[0-9]+\.x\.md" "$filename" | awk -F'/' '{print $2}') | |
| changelogs_mkdocs_arr=( $changelogs_from_mkdocs_file ) | |
| changelogs_dir_arr=( $changelogs_from_dir ) | |
| new_changelog_file="" | |
| # check if all files from CHANGELOG dir are present in mkdocs.yml | |
| for value in "${changelogs_dir_arr[@]}"; do | |
| if [[ ! " ${changelogs_mkdocs_arr[@]} " =~ " $value " ]]; then | |
| # the value of the new_changelog_file will be name of the changelog file, which isn't in mkdocs.yml nav | |
| new_changelog_file=$value | |
| fi | |
| done | |
| # add new navigation entry only, when there is a new changelog file | |
| if [[ -n "$new_changelog_file" ]]; then | |
| echo "Found new changelog file" | |
| version=$(echo $new_changelog_file | grep -oE [0-9]+\.[0-9]+) | |
| navigation_entry="Claudie v$version: CHANGELOG/$new_changelog_file" | |
| new_entry_line=$(($start_line + ${#changelogs_dir_arr[@]})) | |
| sed -i "${new_entry_line}i\\ | |
| - ${navigation_entry}" $filename | |
| git fetch | |
| git checkout -b feat/add-reference-to-new-changelog-${RELEASE} | |
| # commit and push | |
| git commit -am "add new changelog file to mkdocs.yml" | |
| git push --set-upstream origin feat/add-reference-to-new-changelog-${RELEASE} | |
| echo "Altered mkdocs.yml with new Changelog navigation entry was commited and pushed to origin" | |
| gh pr create --title "Add reference to new Changelog ${RELEASE}" --body "Add reference to new Changelog file in mkdocs.yml" | |
| else | |
| echo "There isn't a new changelog file" | |
| fi | |
| # NOTE: the pipeline will fail, if gh-pages branch isn't created!!! | |
| - name: Git fetch gh-pages | |
| run: git fetch origin gh-pages | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.9 | |
| - name: Install Python dependencies | |
| run: pip install -r requirements.txt | |
| # this is only possible, when there is already a version with latest alias | |
| # in case there isn't a version like this you have to | |
| # 1. mike deploy <version> latest | |
| # 2. mike set-default latest | |
| # 3. mike deploy <version_from_cmd_1> latest --push | |
| # --push flag in the latest cmd is necessary, when you want to apply changes in gh-pages branch and also in GH Pages | |
| - name: Deploy new docs version | |
| run: mike deploy ${RELEASE} latest --update-aliases --push |