feat: add npm/package.json ecosystem support #21
Workflow file for this run
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: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - '**/*.rs' | |
| - '**/Cargo.toml' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| paths: | |
| - '**/*.rs' | |
| - '**/Cargo.toml' | |
| permissions: | |
| contents: write | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| build-docs: | |
| name: Build Documentation | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Cache Cargo | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| shared-key: "docs" | |
| - name: Build documentation | |
| run: cargo doc --workspace --no-deps --all-features | |
| env: | |
| RUSTDOCFLAGS: "--cfg docsrs -D warnings" | |
| - name: Add redirect index.html | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| run: | | |
| cat > target/doc/index.html <<EOF | |
| <!DOCTYPE html> | |
| <html> | |
| <head> | |
| <meta charset="utf-8"> | |
| <meta http-equiv="refresh" content="0; url=deps_lsp/index.html"> | |
| <title>Redirecting to deps_lsp</title> | |
| </head> | |
| <body> | |
| <p>Redirecting to <a href="deps_lsp/index.html">deps_lsp documentation</a>...</p> | |
| </body> | |
| </html> | |
| EOF | |
| - name: Deploy to GitHub Pages | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./target/doc | |
| force_orphan: true | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' |