aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/docs.yml
diff options
context:
space:
mode:
authordundargoc <gocdundar@gmail.com>2023-11-12 21:40:24 +0100
committerdundargoc <33953936+dundargoc@users.noreply.github.com>2023-12-09 14:14:38 +0100
commitdd81e1e3345b91c4cb4653b697c1054526f6b924 (patch)
treec5678fbf50ba7c703cf9acffb073ab2880470188 /.github/workflows/docs.yml
parent29aa4dd10af74d29891cb293dc9ff393e9dba11f (diff)
downloadrneovim-dd81e1e3345b91c4cb4653b697c1054526f6b924.tar.gz
rneovim-dd81e1e3345b91c4cb4653b697c1054526f6b924.tar.bz2
rneovim-dd81e1e3345b91c4cb4653b697c1054526f6b924.zip
ci: refactor CI files
Mostly rename file and variable names to be more consistent. This makes it easier to locate them in the "Actions" tab on github.
Diffstat (limited to '.github/workflows/docs.yml')
-rw-r--r--.github/workflows/docs.yml32
1 files changed, 32 insertions, 0 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000000..c47df46b28
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,32 @@
+name: docs
+on:
+ pull_request:
+ types: [opened, synchronize, reopened, ready_for_review]
+ paths:
+ - 'src/nvim/api/*.[ch]'
+ - 'src/nvim/eval.lua'
+ - 'runtime/lua/**.lua'
+ - 'runtime/doc/**'
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ if: github.event.pull_request.draft == false
+ permissions:
+ contents: write
+ pull-requests: write
+ steps:
+ - uses: actions/checkout@v4
+ - uses: ./.github/actions/setup
+
+ - name: Install dependencies
+ run: |
+ sudo apt-get install -y doxygen python3-msgpack
+
+ - name: Generate docs
+ run: |
+ make doc
+ if [ -n "$(git status --porcelain)" ]; then
+ echo "::error::Job failed, run 'make doc' and commit your doc changes."
+ echo "::error::The doc generation produces the following changes:"
+ git diff --color --exit-code
+ fi