Merge pull request #21 from FrozenLemonTee/pre-0.1.6 #8
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
| # .github/workflows/deploy-docs-stable.yml | |
| name: Deploy Documentation - Stable | |
| on: | |
| push: | |
| branches: [ master ] | |
| tags: | |
| - 'v*.*.*' | |
| jobs: | |
| build-and-deploy: | |
| if: github.repository == 'FrozenLemonTee/original' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen graphviz plantuml | |
| - name: Build documentation | |
| run: | | |
| # Create the necessary directory structure | |
| mkdir -p ../original_docs | |
| # Run doxygen | |
| doxygen Doxyfile | |
| # Check whether the document was generated successfully | |
| if [ ! -d "../original_docs/docs/html" ]; then | |
| echo "Error: Documentation was not generated in expected location" | |
| ls -la ../original_docs/docs/ || echo "Docs directory not found" | |
| exit 1 | |
| fi | |
| # Create version information file | |
| echo '<!DOCTYPE html>' > ../original_docs/docs/html/version.html | |
| echo '<html>' >> ../original_docs/docs/html/version.html | |
| echo '<head>' >> ../original_docs/docs/html/version.html | |
| echo ' <title>Version Info</title>' >> ../original_docs/docs/html/version.html | |
| echo '</head>' >> ../original_docs/docs/html/version.html | |
| echo '<body>' >> ../original_docs/docs/html/version.html | |
| echo ' <h1>Documentation Version</h1>' >> ../original_docs/docs/html/version.html | |
| echo ' <p>Version: stable</p>' >> ../original_docs/docs/html/version.html | |
| echo ' <p>Branch: master</p>' >> ../original_docs/docs/html/version.html | |
| echo " <p>Build Date: $(date -u)</p>" >> ../original_docs/docs/html/version.html | |
| echo " <p>Commit: ${{ github.sha }}</p>" >> ../original_docs/docs/html/version.html | |
| echo '</body>' >> ../original_docs/docs/html/version.html | |
| echo '</html>' >> ../original_docs/docs/html/version.html | |
| - name: Deploy to original_docs repository | |
| env: | |
| GH_PAT: ${{ secrets.GH_PAT }} | |
| run: | | |
| # Configure git | |
| git config --global user.name "github-actions[bot]" | |
| git config --global user.email "github-actions[bot]@users.noreply.github.com" | |
| # Clone document repository | |
| git clone -b master https://${{ secrets.GH_PAT }}@github.com/FrozenLemonTee/original_docs.git deploy-repo | |
| cd deploy-repo | |
| # Update stable directory | |
| rm -rf stable | |
| mkdir -p stable | |
| cp -r ../../original_docs/docs/html/* stable/ | |
| # Regenerate the main index.html to include the latest tag version | |
| echo '<!DOCTYPE html>' > index.html | |
| echo '<html>' >> index.html | |
| echo '<head>' >> index.html | |
| echo ' <meta http-equiv="refresh" content="0; url=stable/index.html">' >> index.html | |
| echo '</head>' >> index.html | |
| echo '<body>' >> index.html | |
| echo ' <p>Redirecting to <a href="stable/index.html">stable documentation</a>...</p>' >> index.html | |
| echo ' <p>Available versions:</p>' >> index.html | |
| echo ' <ul>' >> index.html | |
| echo ' <li><a href="stable/index.html">Stable (master branch)</a></li>' >> index.html | |
| echo ' <li><a href="latest/index.html">Latest (test branch)</a></li>' >> index.html | |
| echo ' <li><a href="versions/">Tag versions</a></li>' >> index.html | |
| echo ' </ul>' >> index.html | |
| echo ' <p>Recent tag versions:</p>' >> index.html | |
| echo ' <ul>' >> index.html | |
| # Regenerate the list of recent tag versions (last 5) | |
| for dir in $(ls -1 versions/ 2>/dev/null | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | sort -V -r | head -5); do | |
| echo " <li><a href=\"versions/$dir/index.html\">Version $dir</a></li>" >> index.html | |
| done | |
| echo ' </ul>' >> index.html | |
| echo '</body>' >> index.html | |
| echo '</html>' >> index.html | |
| # Also update versions/index.html to ensure that the list of all versions is up to date | |
| echo '<!DOCTYPE html>' > versions/index.html | |
| echo '<html>' >> versions/index.html | |
| echo '<head>' >> versions/index.html | |
| echo ' <title>Versioned Documentation</title>' >> versions/index.html | |
| echo '</head>' >> versions/index.html | |
| echo '<body>' >> versions/index.html | |
| echo ' <h1>Versioned Documentation</h1>' >> versions/index.html | |
| echo ' <p>Select a version:</p>' >> versions/index.html | |
| echo ' <ul>' >> versions/index.html | |
| # List all versions (from newest to oldest) | |
| for dir in $(ls -1 versions/ 2>/dev/null | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | sort -V -r); do | |
| echo " <li><a href=\"$dir/index.html\">Version $dir</a></li>" >> versions/index.html | |
| done | |
| echo ' </ul>' >> versions/index.html | |
| echo ' <p><a href="../stable/index.html">Stable (master branch)</a></p>' >> versions/index.html | |
| echo ' <p><a href="../latest/index.html">Latest (test branch)</a></p>' >> versions/index.html | |
| echo '</body>' >> versions/index.html | |
| echo '</html>' >> versions/index.html | |
| # Submit and push | |
| git add . | |
| if git diff-index --quiet HEAD --; then | |
| echo "No changes to deploy" | |
| else | |
| git commit -m "Deploy stable documentation from ${{ github.sha }} and update version lists" | |
| git push origin master | |
| echo "✅ Stable documentation deployed successfully with updated version lists" | |
| fi |