diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-10-01 05:39:12 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-01 05:39:12 -0700 |
| commit | bedb2a0df105f68a624a49b867f269b6d55a2c89 (patch) | |
| tree | 877aa3ef8277575a7ffea1ff8f280eeb69b47489 /.github/workflows | |
| parent | docs: CONTRIBUTING.md cleanup (diff) | |
| download | nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.gz nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.bz2 nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.lz nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.xz nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.tar.zst nvim-lspconfig-bedb2a0df105f68a624a49b867f269b6d55a2c89.zip | |
refactor: rename "server_configurations" => "configs" #3330
Problem:
The name `server_configurations` is extremely verbose and irritatingly
formal and dogmatic. This overlong name is a constant nuisance when
reading, writing, and coding.
It's also not even correct: these configurations are just as much
"client" configurations as they are "server" configurations.
Solution:
- Rename to a shorter name.
- Leave placeholder files for any old URLs that link to the old
location.
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/codespell.yml | 2 | ||||
| -rw-r--r-- | .github/workflows/comment-config-changes.yml | 4 | ||||
| -rw-r--r-- | .github/workflows/docgen.yml | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index c43f7616..31c713c5 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -8,4 +8,4 @@ jobs: - name: Install codespell run: pip install codespell - name: Use codespell - run: codespell --quiet-level=2 --check-hidden --skip=./doc/server_configurations.md,./doc/server_configurations.txt --ignore-words=.codespellignorewords + run: codespell --quiet-level=2 --check-hidden --skip=./doc/configs.md,./doc/configs.txt --ignore-words=.codespellignorewords diff --git a/.github/workflows/comment-config-changes.yml b/.github/workflows/comment-config-changes.yml index 40bcaafa..5bcc8008 100644 --- a/.github/workflows/comment-config-changes.yml +++ b/.github/workflows/comment-config-changes.yml @@ -14,6 +14,6 @@ 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 doc/server_configurations.txt; then - gh pr comment $PR_NUMBER --body 'Note that `server_configurations.md` or `server_configurations.txt` will be regenerated by the docgen CI process. Edit the Lua source file instead. For details on generating documentation, see: https://github.com/neovim/nvim-lspconfig/blob/master/CONTRIBUTING.md#generating-docs' + if ! git diff origin/$GITHUB_BASE_REF...$(git branch --show-current) --exit-code -- doc/configs.md doc/configs.txt; then + gh pr comment $PR_NUMBER --body 'Note that `configs.md` or `configs.txt` will be regenerated by the docgen CI process. Edit the Lua source file instead. For details on generating documentation, see: https://github.com/neovim/nvim-lspconfig/blob/master/CONTRIBUTING.md#generating-docs' fi diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml index 678b00d4..751837d0 100644 --- a/.github/workflows/docgen.yml +++ b/.github/workflows/docgen.yml @@ -22,11 +22,11 @@ jobs: - name: Commit changes env: COMMIT_MSG: | - docs: update server_configurations.md + docs: update configs.md skip-checks: true run: | git config user.name "github-actions[bot]" git config user.email "github-actions[bot]@users.noreply.github.com" - git add doc/server_configurations.md doc/server_configurations.txt + git add doc/configs.md doc/configs.txt # Only commit and push if we have changes git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push) |