ci: added auto-gen for docs

This commit is contained in:
Folke Lemaitre 2024-06-19 06:53:23 +02:00
parent 7e8454c934
commit f519ed9ba9
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
2 changed files with 31 additions and 4 deletions

View File

@ -4,17 +4,45 @@ on:
push: push:
branches: branches:
- docs - docs
# Review gh actions docs if you want to further define triggers, paths, etc - main
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on workflow_dispatch:
jobs: jobs:
build: build:
name: Generate docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: docs
- name: Install Neovim
shell: bash
run: |
mkdir -p /tmp/nvim
wget -q https://github.com/neovim/neovim/releases/download/nightly/nvim.appimage -O /tmp/nvim/nvim.appimage
cd /tmp/nvim
chmod a+x ./nvim.appimage
./nvim.appimage --appimage-extract
echo "/tmp/nvim/squashfs-root/usr/bin/" >> $GITHUB_PATH
- name: Generate docs
run: ./build.sh
- name: Push changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "chore(build): auto-generate docs"
commit_user_name: "github-actions[bot]"
commit_user_email: "github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
docusaurus:
name: Build Docusaurus name: Build Docusaurus
needs: build
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
ref: docs
- uses: pnpm/action-setup@v4 - uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4 - uses: actions/setup-node@v4
with: with:
@ -33,7 +61,7 @@ jobs:
deploy: deploy:
name: Deploy to GitHub Pages name: Deploy to GitHub Pages
needs: build needs: docusaurus
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions: permissions:

View File

@ -16,7 +16,6 @@ const config: Config = {
organizationName: "folke", // Usually your GitHub org/user name. organizationName: "folke", // Usually your GitHub org/user name.
projectName: "lazy.nvim", // Usually your repo name. projectName: "lazy.nvim", // Usually your repo name.
deploymentBranch: "gh-pages",
// Even if you don't use internationalization, you can use this field to set // Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you // useful metadata like html lang. For example, if your site is Chinese, you