mat/azalea
1
2
Fork 0
mirror of https://github.com/mat-1/azalea.git synced 2025-08-02 14:26:04 +00:00
Code Issues Projects Releases Packages Activity

Better Docs

Browse source
This commit is contained in:
Aditya Kumar 2024-11-24 17:25:31 +05:30
parent dfdc3144b6
commit 6ee42c4c4f
No known key found for this signature in database
1 changed files with 45 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
.github/workflows/doc.yml vendored
View file

@ -1,45 +1,61 @@
name: Doc name: Generate Documentation
on: on:
push: push:
branches:
- main
workflow_dispatch: workflow_dispatch:
permissions: permissions:
contents: write contents: write
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs: jobs:
deploy: deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repository - name: Checkout Repository
uses: actions/checkout@v3 uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
- name: Install Rust Toolchain
uses: rs-workspace/rust-toolchain@v0.1.0
with: with:
toolchain: nightly toolchain: nightly
- run: cargo doc --workspace --no-deps
- uses: "finnp/create-file-action@master" - name: Generate Documentation
env: run: RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --workspace --no-deps
FILE_NAME: "./target/doc/index.html"
FILE_DATA: '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0;url=''./azalea''"/></head></html>' # Redirect to default page - name: Prepare Documentation
run: |
- name: Setup Pages BRANCH_NAME=$(echo "${GITHUB_REF##*/}" | tr '/' '_') # Get branch name safely
uses: actions/configure-pages@v2 mkdir -p versioned_docs/$BRANCH_NAME
- name: Upload artifact cp -r target/doc/* versioned_docs/$BRANCH_NAME
uses: actions/upload-pages-artifact@v1
with: - name: Checkout to Docs Branch
path: './target/doc/' run: |
- name: Deploy to GitHub Pages git config --global user.name "github-actions[bot]"
id: deployment git config --global user.email "github-actions[bot]@users.noreply.github.com"
uses: actions/deploy-pages@v1 git fetch origin docs || git checkout --orphan docs
git checkout docs
cp -r versioned_docs/* ./ # Copy docs to branch root
rm -rf versioned_docs # Clean up
rm -rf target # Clean up
- name: Generate README.md
run: |
VERSIONS=$(ls -d */ | sed 's#/##' | sort -r) # Get all version directories and sort them (latest first)
rm README.md # Delete README.md and generate a new one
echo "# Azalea Docs" > README.md
echo "Welcome to the documentation for Azalea Crate." >> README.md
echo "" >> README.md
# Update README.md with available versions
echo "## Available Versions" >> README.md
for VERSION in $VERSIONS; do
echo "- [$VERSION](./$VERSION/index.html)" >> README.md
done
echo "README.md updated successfully."
- name: Deploy Documentation to Docs Branch
run: |
git add .
git commit -m "Update documentation for $GITHUB_REF_NAME" || echo "No changes to commit"
git push origin docs