diff options
| author | Javier Lopez <graulopezjavier@gmail.com> | 2021-11-30 09:27:12 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-30 09:27:12 -0500 |
| commit | cea6e0b0f6c7daf671b478bd58571768d0385711 (patch) | |
| tree | 2ad11ab0887274b6e786e3750f2e944308e21989 /.github/workflows | |
| parent | chore: use client.request instead of buf_request (#1503) (diff) | |
| download | nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.gz nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.bz2 nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.lz nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.xz nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.zst nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.zip | |
fix(help): workaround plugin/users overwritting tags (#1512)
Most plugin managers run :helptags in the plugin, which silently
overwrites the existing doc/tags. this is an issue for us since lspconfig
is manipulating the tags file to point to servers_configurations.md
Instead create a markdown comment with the name of the wanted tag and
make a copy in the repository of servers_configurations.md to
server_configurations.txt. Now when :helptags runs it finds the txt file
and generates the appropriate tag.
The advantage is this solution should work in all platforms, it also
removes lines from docgen CI.
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/close-config-changes.yml | 2 | ||||
| -rw-r--r-- | .github/workflows/codespell.yml | 2 | ||||
| -rw-r--r-- | .github/workflows/docgen.yml | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/.github/workflows/close-config-changes.yml b/.github/workflows/close-config-changes.yml index 8ab231d8..b45a755e 100644 --- a/.github/workflows/close-config-changes.yml +++ b/.github/workflows/close-config-changes.yml @@ -14,7 +14,7 @@ jobs: fetch-depth: 0 ref: ${{ github.event.pull_request.head.sha }} - run: | - if ! git diff origin/$GITHUB_BASE_REF...$(git branch --show-current) --exit-code -- doc/server_configurations.md; then + if ! git diff origin/$GITHUB_BASE_REF...$(git branch --show-current) --exit-code -- doc/server_configurations.md doc/server_configurations.txt; then gh pr close $PR_NUMBER gh pr comment $PR_NUMBER --body "This pull request has been automatically closed. Changes to server_configurations.md aren't allowed - edit the lua source file instead. Consult https://github.com/neovim/nvim-lspconfig/blob/master/CONTRIBUTING.md#generating-docs." exit 1 diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 7a6cfe13..e2876384 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -18,4 +18,4 @@ jobs: pip install codespell - name: Use codespell run: | - codespell --quiet-level=2 --check-hidden --skip=./doc/server_configurations.md --ignore-words=.codespellignorewords || exit + codespell --quiet-level=2 --check-hidden --skip=./doc/server_configurations.md,./doc/server_configurations.txt --ignore-words=.codespellignorewords || exit diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml index 2e410a20..a0fdeaa5 100644 --- a/.github/workflows/docgen.yml +++ b/.github/workflows/docgen.yml @@ -27,6 +27,6 @@ jobs: run: | git config user.name github-actions git config user.email github-actions@github.com - git add doc/server_configurations.md + git add doc/server_configurations.md doc/server_configurations.txt # Only commit and push if we have changes git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push) |