feat(docs): modify docs workflow (#4)

* feat: modified `.yml` files max length

* docs: updated to inform about Neovim min version allowed

* ci(docs): modified to `skip-checks` and for better commits

* docs: update `doc/freeze-code.nvim.txt`
skip-checks: true

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.github/workflows/docs.yml

@@ -2,14 +2,11 @@ name: docs
 
 on:
   push:
+    branches-ignore:
+      - main
+  pull_request:
     branches:
       - main
-    paths:
-      - "README.md"
-
-permissions:
-  actions: write
-  contents: write
 
 jobs:
   docs:
@@ -23,14 +20,19 @@ jobs:
         uses: kdheepak/panvimdoc@main
         with:
           vimdoc: freeze-code.nvim
-          version: "Neovim >= 0.8.0"
+          version: "Neovim >= 0.9.0"
           demojify: true
           treesitter: true
-      - name: Push changes
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: "docs: auto-generate vimdoc"
-          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>"
+      - name: Update documentation
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MSG: |
+            docs: update `doc/freeze-code.nvim.txt`
+            skip-checks: true
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+          git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          git add doc/
+          # Only commit and push if we have changes
+          git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin HEAD:${GITHUB_REF})

.yamllint.yml

@@ -5,6 +5,6 @@ rules:
     present: false
   line-length:
     level: warning
-    max: 80
+    max: 200
     allow-non-breakable-words: true
     allow-non-breakable-inline-mappings: true

README.md

@@ -5,7 +5,7 @@
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 
-# Freeze NeoVim Plugin
+# Freeze Neovim Plugin
 
 Take a "screenshot" of your code by turning it into an image, thanks to
 [freeze](https://github.com/charmbracelet/freeze) by [charm](https://charm.sh/).
@@ -17,6 +17,10 @@ Take a "screenshot" of your code by turning it into an image, thanks to
 
 </div>
 
+> [!warning]
+>
+> This plugin requires Neovim v0.9.0 or higher
+
 ## Installation
 
 Using your plugin manager at your disposal, in the example

doc/freeze-code.nvim.txt

@@ -1,4 +1,4 @@
-*freeze-code.nvim.txt*       For Neovim >= 0.8.0      Last change: 2024 May 14
+*freeze-code.nvim.txt*       For Neovim >= 0.9.0      Last change: 2024 May 14
 
 ==============================================================================
 Table of Contents                         *freeze-code.nvim-table-of-contents*
@@ -9,6 +9,9 @@ Table of Contents                         *freeze-code.nvim-table-of-contents*
 
 
 
+  [!warning]
+  This plugin requires Neovim v0.9.0 or higher
+
 INSTALLATION                                   *freeze-code.nvim-installation*
 
 Using your plugin manager at your disposal, in the example lazy
@@ -53,7 +56,8 @@ Using your plugin manager at your disposal, in the example lazy
 <
 
 
-  [!note] See default configuration below.
+  [!note]
+  See default configuration below.
 >lua
     local opts = {
       freeze_path = vim.fn.exepath("freeze"), -- where is freeze installed
@@ -70,7 +74,8 @@ Using your plugin manager at your disposal, in the example lazy
 <
 
 
-  [!note] The commands to copy, as defaults per OS will be in the bin-directory
+  [!note]
+  The commands to copy, as defaults per OS will be in the bin-directory
   <https://github.com/AlejandroSuero/freeze-code.nvim/blob/main/bin>
 Once you have it installed, you can use `:checkhealt freeze-code` to see if
 there are any problems with the installation or you need to install aditional
@@ -96,7 +101,7 @@ project.
 7. Open a PR <https://github.com/AlejandroSuero/freeze-code.nvim/pulls>.
 
 For more information, check CONTRIBUTING.md
-<https://github.com/AlejandroSuero/freeze-code.nvim/blob/main/contrib/CONTRIBUTING.md>.
+<https://github.com/AlejandroSuero/freeze-code.nvim/blob/main/CONTRIBUTING.md>.
 
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

plugin/freeze-code.lua

@@ -1,5 +1,12 @@
 if vim.fn.has("nvim-0.9.0") ~= 1 then
-  vim.api.nvim_err_writeln("[freeze-code] plugin requires at least NeoVim 0.9.0.")
+  local current_version = vim.version()
+  local err_msg = string.format(
+    "[freeze-code] plugin requires at least NeoVim v0.9.0, current version: v%s.%s.%s",
+    current_version.major,
+    current_version.minor,
+    current_version.patch
+  )
+  vim.api.nvim_err_writeln(err_msg)
   return
 end