Update README.md #17
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| tags: | |
| - '*' | |
| pull_request: | |
| jobs: | |
| build: | |
| name: Build + Publish Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: '📥 Checkout repository' | |
| uses: actions/checkout@v3 | |
| - name: '💎 Setup Ruby' | |
| uses: actions/setup-ruby@v1 | |
| - name: '🔧 Set versions' | |
| id: versions | |
| run: | | |
| if [[ $GITHUB_REF =~ ^refs/tags/ ]]; then | |
| version="${GITHUB_REF/refs\/tags\//}" | |
| commit_message="Release $version" | |
| else | |
| version=master | |
| commit_message="Master" | |
| fi | |
| echo "::set-output name=commit_message::$commit_message" | |
| echo "::set-output name=version::$version" | |
| - name: '🔨 Build' | |
| run: | | |
| gem install yard | |
| readme_link=https://github.com/piotr-iohk/vendi/blob/${{ steps.versions.outputs.version }}/README.md | |
| yard doc --title "Documentation for Vendi (${{ steps.versions.outputs.version }})" | |
| sed -i "s|<a href=\"index.html\" title=\"README\">|<a href=\"$readme_link\" title=\"README\">|" ./doc/_index.html | |
| cp ./doc/_index.html ./doc/index.html | |
| - name: '🚀 Publish' | |
| if: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags') }} | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: doc | |
| destination_dir: ${{ steps.versions.outputs.version }} | |
| full_commit_message: ${{ steps.versions.outputs.commit_message }} |