generated from metakgp/README.md
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added workflow to generate backend docs
- Loading branch information
1 parent
4c4e401
commit 6a9a353
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Generate API Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- "backend/**" | ||
- ".github/workflows/docs.yaml" | ||
|
||
jobs: | ||
gen_docs: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
with: | ||
ref: docs | ||
|
||
- name: Reset Branch | ||
run: | | ||
git fetch origin | ||
git reset --hard 'origin/${{ github.ref_name }}' | ||
- name: Install Rust and Dependencies | ||
run: | | ||
sudo apt install libwebkit2gtk-4.0-dev build-essential curl wget file libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev | ||
rustup update stable && rustup default stable | ||
- name: Generate Rust Docs | ||
run: | | ||
pushd backend/ | ||
cargo doc --no-deps | ||
mv target/doc/ ../docs/ | ||
popd | ||
- uses: EndBug/add-and-commit@v9 # You can change this to use a specific version. | ||
with: | ||
add: 'docs -f' | ||
commit: --signoff | ||
message: 'docs: updated API documentation' | ||
push: origin docs -f |