Publish Docs #349
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: Publish Docs | |
on: | |
push: | |
branches: | |
- main | |
# TODO: replace with on push tag https://github.com/actions/deploy-pages/issues/76 | |
workflow_run: | |
workflows: [Publish Release] | |
types: | |
- completed | |
jobs: | |
publish: | |
runs-on: ubuntu-latest | |
if: github.repository == 'vanniktech/gradle-maven-publish-plugin' | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: Install MkDocs Material | |
run: pip install mkdocs-material | |
- name: Copy docs | |
run: | | |
cp README.md docs/index.md | |
cp CHANGELOG.md docs/changelog.md | |
# Update page title | |
sed -i 's/# gradle-maven-publish-plugin/# Overview/' docs/index.md | |
# Update plugin version | |
sed -i "s/<latest-version>/$(git describe --tags --abbrev=0)/" docs/base.md | |
sed -i "s/<latest-version>/$(git describe --tags --abbrev=0)/" docs/central.md | |
sed -i "s/<latest-version>/$(git describe --tags --abbrev=0)/" docs/other.md | |
- name: Build MkDocs | |
run: mkdocs build | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: site | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |