yew/.github/workflows/build-api-docs.yml
WorldSEnder 3871418174
Modernize github workflows (#3711)
* modernize github workflows

this mainly fixes some inconsistencies in style, outdated or wrong comments and action version
- replace Legit-Labs/action-download-artifact with actions/download-artifact
- fix Swatinem/rust-cache arguments
- fix benchmark transformations
- expand feature soundness lints
- wording and capitalization in comments

* fix no_run on crate level doc

* fix some more small issues
2024-08-22 20:04:04 +05:00

65 lines
1.6 KiB
YAML

name: Build API Docs (Rustdoc)
on:
pull_request:
branches: [master]
paths:
- "packages/**"
- "firebase.json"
- ".github/workflows/*-docs.yml"
push:
branches: [master]
paths:
- "packages/**"
- "firebase.json"
- ".github/workflows/*-docs.yml"
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly
components: rust-docs
- name: Run cargo doc
env:
RUSTDOCFLAGS: --cfg documenting --html-before-content ./api-docs/before-content.html --extend-css ./api-docs/styles.css -Z unstable-options --enable-index-page
run: |
cargo doc \
--no-deps \
--all-features \
-p yew \
-p yew-macro \
-p yew-router \
-p yew-router-macro \
-p yew-agent
- name: Move files in correct directory
run: |
mkdir -p api-docs/dist/next
cp -r target/doc/* api-docs/dist/next
- name: Upload build artifact
uses: actions/upload-artifact@v4
with:
name: api-docs
path: api-docs/
retention-days: 1
- if: github.event_name == 'pull_request'
name: Build pr info
run: |
echo "${{ github.event.number }}" > .PR_INFO
- if: github.event_name == 'pull_request'
name: Upload pr info
uses: actions/upload-artifact@v4
with:
name: pr-info
path: .PR_INFO
retention-days: 1