From 24bc0f4049c30e3303934ce76fdf1d22bdd78853 Mon Sep 17 00:00:00 2001 From: Michael Chris Lopez Date: Thu, 28 Oct 2021 06:10:43 +0800 Subject: [PATCH 1/4] docs: copy lualine workflow --- .github/workflows/doc.yml | 61 +++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 96451d5..d1ae9f1 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -1,38 +1,37 @@ -# 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: - branches: [ main, dev ] + push: + 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: - # The type of runner that the job will run on - runs-on: ubuntu-latest + vimdocgen: + runs-on: ubuntu-latest - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 + steps: + - uses: actions/checkout@v2 + - name: Setup git + run: | + git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" + git config --local user.name "github-actions[bot]" + printf 'VIMDOC_BRANCH=bot/vimdoc/%s\n' ${GITHUB_REF#refs/heads/} >> $GITHUB_ENV - - name: panvimdoc - 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" - - uses: stefanzweifel/git-auto-commit-action@v4 - with: - commit_message: "auto generate docs" - branch: ${{ github.head_ref }} - file_pattern: doc/zenbones.txt + - name: Checkout to vimdoc branch + run: git checkout -b ${VIMDOC_BRANCH} + + - name: panvimdoc + 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 From ea692e8fa3f8876c3e47f3c280d585eb8e62c8a1 Mon Sep 17 00:00:00 2001 From: Michael Chris Lopez Date: Thu, 28 Oct 2021 06:16:31 +0800 Subject: [PATCH 2/4] doc: cleanup --- .github/workflows/doc.yml | 6 ++++++ doc/zenbones.md | 8 ++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index d1ae9f1..0f7e08c 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -8,6 +8,12 @@ jobs: vimdocgen: runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: - uses: actions/checkout@v2 - name: Setup git diff --git a/doc/zenbones.md b/doc/zenbones.md index bb49e3b..07f9c0b 100644 --- a/doc/zenbones.md +++ b/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 From 29660d00588c24f213eee7c2efbe62a9cd1ba29c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 28 Oct 2021 06:28:36 +0800 Subject: [PATCH 3/4] chore: generated vimdoc (#20) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- doc/zenbones.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/zenbones.txt b/doc/zenbones.txt index 6c09fed..72d08cd 100644 --- a/doc/zenbones.txt +++ b/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* From 2fd73f2b9b38f8490d93905d434a929e10e617d7 Mon Sep 17 00:00:00 2001 From: Michael Chris Lopez Date: Thu, 28 Oct 2021 06:31:14 +0800 Subject: [PATCH 4/4] doc: generate for main branch only --- .github/workflows/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 0f7e08c..54a6566 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -2,7 +2,7 @@ name: doc on: push: - branches: [main, dev] + branches: [main] jobs: vimdocgen: