feat: Add changelog for version 0.2.0 with detailed updates on protoc… #14
This file contains hidden or 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: Deploy Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - run: pip install mkdocs-material | |
| - name: Prepare docs for MkDocs | |
| run: | | |
| # Copy root-level docs into docs/ | |
| cp README.md docs/index.md | |
| cp PROTOCOL_SPEC.md docs/ | |
| cp SCOPE.md docs/ | |
| mkdir -p docs/assets | |
| cp apcore-logo.svg docs/assets/ | |
| # Fix links in index.md: ./docs/X → ./X and (docs/X → (X | |
| sed -i 's|\./docs/|./|g' docs/index.md | |
| sed -i 's|(docs/|(|g' docs/index.md | |
| sed -i 's|\.\./README\.md|../index.md|g' docs/index.md | |
| sed -i 's|\./apcore-logo\.svg|./assets/apcore-logo.svg|g' docs/index.md | |
| # Fix links in subdirectories: ../../PROTOCOL_SPEC.md → ../PROTOCOL_SPEC.md | |
| find docs -name '*.md' -not -name 'index.md' -exec sed -i 's|\.\./\.\./PROTOCOL_SPEC\.md|../PROTOCOL_SPEC.md|g' {} + | |
| find docs -name '*.md' -not -name 'index.md' -exec sed -i 's|\.\./\.\./SCOPE\.md|../SCOPE.md|g' {} + | |
| # Fix docs/README.md link to root README | |
| sed -i 's|\.\./README\.md|index.md|g' docs/README.md | |
| # Fix copied PROTOCOL_SPEC.md and SCOPE.md: docs/X → X | |
| sed -i 's|docs/||g' docs/PROTOCOL_SPEC.md | |
| sed -i 's|\./docs/|./|g' docs/SCOPE.md | |
| sed -i 's|(docs/|(|g' docs/SCOPE.md | |
| # Fix top-level docs files (concepts.md, architecture.md): | |
| # ../PROTOCOL_SPEC.md → PROTOCOL_SPEC.md, ../api/ → api/ | |
| for f in docs/concepts.md docs/architecture.md; do | |
| sed -i 's|\.\./PROTOCOL_SPEC\.md|PROTOCOL_SPEC.md|g' "$f" | |
| sed -i 's|\.\./SCOPE\.md|SCOPE.md|g' "$f" | |
| sed -i 's|\.\./api/|api/|g' "$f" | |
| sed -i 's|\.\./guides/|guides/|g' "$f" | |
| sed -i 's|\.\./spec/|spec/|g' "$f" | |
| done | |
| - run: mkdocs build | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |