git-bot-feedback 0.8.5

A library designed for CI tools that posts comments on a Pull Request.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

name: Docs build

on:
  push:
    branches: [main]
    paths:
      - docs/**/*
      - nurfile
      - uv.lock
      - src/**/*.rs
      - bindings/python/**/*
      - .github/workflows/docs.yml
  pull_request:
    branches: [main]
    paths:
      - docs/**/*
      - nurfile
      - uv.lock
      - src/**/*.rs
      - bindings/python/**/*
      - .github/workflows/docs.yml

permissions: {}

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' && !startsWith(github.ref, 'refs/tags/') }}

jobs:
  py-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
      - uses: actions/setup-python@v7.0.0
        with:
          python-version: 3.x
      - name: Setup Rust
        run: rustup update --no-self-update
      - uses: cargo-bins/cargo-binstall@422f3094be6a0843857aa008b499caaf6bce0da8 # v1.24.0
      - name: Install nur
        env:
          GITHUB_TOKEN: ${{ github.token }}
        run: cargo binstall -y nur
      - name: Install uv
        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
      - name: Cache rust deps
        uses: actions/cache@v6.1.0
        with:
          path: |
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: cargo-pyo3-docs-${{ hashFiles('src/**', 'bindings/python/src/**', 'Cargo.lock') }}
      - name: Build docs
        run: nur docs py
      - name: Upload docs
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs/_build/html

  deploy-docs:
    name: Deploy docs
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    needs: [py-docs]
    environment:
      name: github-pages
      url: ${{ steps.deploy-pages.outputs.page_url }}
    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source
    steps:
      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@v5
        id: deploy-pages

  rs-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
      - name: Setup Rust
        run: rustup update --no-self-update
      - uses: cargo-bins/cargo-binstall@422f3094be6a0843857aa008b499caaf6bce0da8 # v1.24.0
      - name: Install nur
        env:
          GITHUB_TOKEN: ${{ github.token }}
        run: cargo binstall -y nur
      - name: Cache rust deps
        uses: actions/cache@v6.1.0
        with:
          path: |
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: cargo-rs-docs-${{ hashFiles('src/**', 'Cargo.lock') }}
      - name: Build docs
        run: nur docs
      - name: Upload docs
        uses: actions/upload-artifact@v7
        with:
          path: target/doc/git_bot_feedback
          name: rust-docs