Skip to content

Commit

Permalink
feat: add autogenerated docs (#39)
Browse files Browse the repository at this point in the history
* feat: add auto generated docs

* docs: init options docs
  • Loading branch information
getchoo authored Jul 29, 2023
1 parent 60a1d9b commit a60d227
Show file tree
Hide file tree
Showing 4 changed files with 719 additions and 11 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Update docs

on:
push:
paths:
- "modules/home-manager/**"
- "modules/nixos/**"

permissions:
contents: write


jobs:
update-docs:
runs-on: ubuntu-latest

strategy:
max-parallel: 1
matrix:
package: ["nixos", "home-manager"]

steps:
- uses: actions/checkout@v3
- uses: cachix/install-nix-action@v22

- name: Build doc
run: nix build .#${{ matrix.package }}-doc

- name: Update doc
run: cat result > docs/${{ matrix.package }}-options.md

- name: Get short revision
id: rev
run:
echo "rev=$(git rev parse --short HEAD)" >> "$GITHUB_OUTPUT"

- name: Commit changes
uses: EndBug/add-and-commit@v9
with:
default_author: github_actions
message: "docs: update docs for ${{ steps.rev.outputs.rev }}"
Loading

0 comments on commit a60d227

Please sign in to comment.