project-version 0.1.0

A cross-language project version bumper for multiple project types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

name: Documentation

on:
  push:
    branches: [docs]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    name: Build and Deploy Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - name: Cache dependencies
        uses: Swatinem/rust-cache@v2
      - name: Build documentation
        # Build documentation with README included
        run: cargo doc --no-deps --document-private-items
      - name: Prepare docs for deployment
        run: |
          mkdir -p target/github-pages
          # Copy the contents of target/doc directly to target/github-pages
          cp -r target/doc/* target/github-pages/
          
          # Create a simple landing page that redirects to the API docs
          cat > target/github-pages/index.html << 'EOF'
          <!DOCTYPE html>
          <html>
          <head>
            <meta charset="utf-8">
            <title>Project Version Documentation</title>
            <meta http-equiv="refresh" content="0; url=project_version/index.html">
          </head>
          <body>
            <p>Redirecting to <a href="project_version/index.html">documentation</a>...</p>
          </body>
          </html>
          EOF
          
          # Create a .nojekyll file to disable GitHub Pages Jekyll processing
          touch target/github-pages/.nojekyll
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: "target/github-pages"
  deploy:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4