Merge pull request #21 from mcchrish/dev

Copy doc generation workflow from lualine

.github/workflows/doc.yml

@@ -1,38 +1,43 @@
-# This is a basic workflow to help you get started with Actions
-
 name: doc
 
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events but only for the main branch
+    push:
-  push:
+        branches: [main]
-    branches: [ main, dev ]
 
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
+    vimdocgen:
-  vimdocgen:
+        runs-on: ubuntu-latest
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
+        permissions:
-    steps:
+            contents: write
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+            pull-requests: write
-      - uses: actions/checkout@v2
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: panvimdoc
+        steps:
-        uses: kdheepak/panvimdoc@v2.7.1
+            - uses: actions/checkout@v2
-        with:
+            - name: Setup git
-          # Output vimdoc project name
+              run: |
-          vimdoc: zenbones
+                  git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          pandoc: doc/zenbones.md
+                  git config --local user.name "github-actions[bot]"
-          description: "A collection of contrast-based vim/neovim colorschemes"
+                  printf 'VIMDOC_BRANCH=bot/vimdoc/%s\n' ${GITHUB_REF#refs/heads/} >> $GITHUB_ENV
-          version: "Vim v8.1 / Neovim 0.5.0"
+
-      - uses: stefanzweifel/git-auto-commit-action@v4
+            - name: Checkout to vimdoc branch
-        with:
+              run: git checkout -b ${VIMDOC_BRANCH}
-          commit_message: "auto generate docs"
+
-          branch: ${{ github.head_ref }}
+            - name: panvimdoc
-          file_pattern: doc/zenbones.txt
+              uses: kdheepak/panvimdoc@v2.7.1
+              with:
+                  # Output vimdoc project name
+                  vimdoc: zenbones
+                  pandoc: doc/zenbones.md
+                  description: "A collection of contrast-based vim/neovim colorschemes"
+                  version: "Vim v8.1 / Neovim 0.5.0"
+            - name: Create PR
+              run: |
+                  if ! [[ -z $(git status -s) ]]; then
+                      git add doc/zenbones.txt
+                      git commit -m "chore: generated vimdoc"
+                      git push --force https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY} ${VIMDOC_BRANCH}
+                      gh pr create --fill --base ${GITHUB_REF#refs/heads/} --head ${VIMDOC_BRANCH} || true
+                  fi

doc/zenbones.md

@@ -31,11 +31,13 @@ Configuration is only available for neovim. There are two ways to set
 configuration. First:
 
 ```vim
+" vimscript
 let g:zenbones_solid_line_nr = v:true
 let g:zenbones_darken_comments = 45
 ```
 
 ```lua
+-- lua
 vim.g.zenbones_solid_line_nr = true
 vim.g.zenbones_darken_comments = 45
 ```
@@ -43,10 +45,12 @@ vim.g.zenbones_darken_comments = 45
 Second way is to set configuration is to assign a dictionary to the prefix:
 
 ```vim
+" vimscript
 let g:forestbones = #{ solid_line_nr: v:true, darken_comments: 45 }
 ```
 
 ```lua
+-- lua
 vim.g.forestbones = { solid_line_nr = true, darken_comments = 45 }
 ```
 
@@ -54,7 +58,7 @@ vim.g.forestbones = { solid_line_nr = true, darken_comments = 45 }
 the flavor name e.g. `g:rosebones_italic_comments`.
 
 | Option                    | Background | Default | Description                                                                                 |
-| :------------------------ | :--------- | :------ | :------------------------------------------------------------------------------------------ |
+| ------------------------- | ---------- | ------- | ------------------------------------------------------------------------------------------- |
 | lightness                 | light      | `nil`   | Change background colors lightness. Options: `'bright'`, `'dim'`.                           |
 | darkness                  | dark       | `nil`   | Change background colors darkness. Options: `'stark'`, `'warm'`.                            |
 | solid_vert_split          | both       | `false` | Solid \|hl-VertSplit\| background.                                                          |
@@ -72,7 +76,7 @@ the flavor name e.g. `g:rosebones_italic_comments`.
 
 #### g:zenbones_compat
 
-Set to `1` to turn on compatibility mode.
+Set to `1` to turn on compatibility mode. Turned on in vim.
 
 #### lightline
 

doc/zenbones.txt

@@ -43,12 +43,14 @@ Configuration is only available for neovim. There are two ways to set
 configuration. First:
 
 >
+    " vimscript
     let g:zenbones_solid_line_nr = v:true
     let g:zenbones_darken_comments = 45
 <
 
 
 >
+    -- lua
     vim.g.zenbones_solid_line_nr = true
     vim.g.zenbones_darken_comments = 45
 <
@@ -57,11 +59,13 @@ configuration. First:
 Second way is to set configuration is to assign a dictionary to the prefix:
 
 >
+    " vimscript
     let g:forestbones = #{ solid_line_nr: v:true, darken_comments: 45 }
 <
 
 
 >
+    -- lua
     vim.g.forestbones = { solid_line_nr = true, darken_comments = 45 }
 <
 
@@ -105,7 +109,7 @@ the flavor name e.g. `g:rosebones_italic_comments`.
                                                   *zenbones-g:zenbones_compat*
 
 g:zenbones_compat                      Set to `1` to turn on compatibility
-                                       mode.
+                                       mode. Turned on in vim.
 
 
                                                           *zenbones-lightline*