fix: docs workflow should fail if out-of-date

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>

.github/workflows/documentation.yaml

@@ -10,7 +10,6 @@ on:
   workflow_dispatch:
 
 jobs:
-
   zshelldoc:
     runs-on: ubuntu-latest
     steps:
@@ -26,5 +25,6 @@ jobs:
       - name: check for out-of-date documentation
         run: |
           if ! git --no-pager diff --exit-code; then
-            echo "::set-output zshelldocs are out-of-date, run 'make doc'"
+            echo "::error:: Z-shelldocs are out-of-date. To regenerate, run 'make doc'"
+            exit 1
           fi

doc/zsdoc/zinit-install.zsh.adoc

@@ -63,7 +63,7 @@ Uses feature(s): _source_
 ~~~~~~~~~~~~~~
 
 ____
- 
+
  ]]]
  FUNCTION: .zinit-at-eval [[[
 ____
@@ -84,11 +84,11 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-compile-plugin [[[
  Compiles given plugin (its main source file, and also an
  additional "....zsh" file if it exists).
- 
+
  $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
  $2 - plugin (only when $1 - i.e. user - given)
 ____
@@ -112,13 +112,13 @@ Called by:
 ~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-compinit [[[
  User-exposed `compinit' frontend which first ensures that all
  completions managed by Zinit are forgotten by Zshell. After
  that it runs normal `compinit', which should more easily detect
  Zinit's completions.
- 
+
  No arguments.
 ____
 
@@ -142,7 +142,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-download-file-stdout [[[
  Downloads file to stdout. Supports following backend commands:
  curl, wget, lftp, lynx. Used by snippet loading.
@@ -166,7 +166,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-download-snippet [[[
  Downloads snippet – either a file – with curl, wget, lftp or lynx,
  or a directory, with Subversion – when svn-ICE is active. Github
@@ -192,7 +192,7 @@ Called by:
 ~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-extract [[[
 ____
 
@@ -213,11 +213,11 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-forget-completion [[[
  Implements alternation of Zsh state so that already initialized
  completion stops being visible to Zsh.
- 
+
  $1 - completion function name, e.g. "_cp"; can also be "cp"
 ____
 
@@ -236,7 +236,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-get-cygwin-package [[[
 ____
 
@@ -255,7 +255,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-get-latest-gh-r-url-part [[[
  Gets version string of latest release of given Github
  package. Connects to Github releases page.
@@ -277,7 +277,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-get-package [[[
 ____
 
@@ -301,7 +301,7 @@ _Environment variables used:_ zinit.zsh -> ZPFX
 ~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-get-url-mtime [[[
  For the given URL returns the date in the Last-Modified
  header as a time stamp
@@ -319,13 +319,13 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-install-completions [[[
  Installs all completions of given plugin. After that they are
  visible to `compinit'. Visible completions can be selectively
  disabled and enabled. User can access completion data with
  `clist' or `completions' subcommand.
- 
+
  $1 - plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
  $2 - plugin (only when $1 - i.e. user - given)
  $3 - if 1, then reinstall, otherwise only install completions that aren't there
@@ -351,7 +351,7 @@ Called by:
 ~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-jq-check [[[
  Check if jq is available and outputs an error message with instructions if
  that's not the case
@@ -372,7 +372,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-json-get-value [[[
  Wrapper around jq that return the value of a property
  $1: JSON structure
@@ -389,7 +389,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-json-to-array [[[
  Wrapper around jq that sets key/values of an associative array, replicating
  the structure of a given JSON object
@@ -412,14 +412,14 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-mirror-using-svn [[[
  Used to clone subdirectories from Github. If in update mode
  (see $2), then invokes `svn update', in normal mode invokes
  `svn checkout --non-interactive -q <URL>'. In test mode only
  compares remote and local revision and outputs true if update
  is needed.
- 
+
  $1 - URL
  $2 - mode, "" - normal, "-u" - update, "-t" - test
  $3 - subdirectory (not path) with working copy, needed for -t and -u
@@ -437,12 +437,12 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-setup-plugin-dir [[[
  Clones given plugin into PLUGIN_DIR. Supports multiple
  sites (respecting `from' and `proto' ice modifiers).
  Invokes compilation of plugin's main file.
- 
+
  $1 - user
  $2 - plugin
 ____
@@ -468,7 +468,7 @@ Called by:
 ~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: .zinit-update-snippet [[[
 ____
 
@@ -489,7 +489,7 @@ zicp
 ~~~~
 
 ____
- 
+
  FUNCTION: zicp [[[
 ____
 
@@ -507,13 +507,13 @@ ziextract
 ~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ziextract [[[
  If the file is an archive, it is extracted by this function.
  Next stage is scanning of files with the common utility `file',
  to detect executables. They are given +x mode. There are also
  messages to the user on performed actions.
- 
+
  $1 - url
  $2 - file
 ____
@@ -546,7 +546,7 @@ zpextract
 ~~~~~~~~~
 
 ____
- 
+
  FUNCTION: zpextract [[[
 ____
 
@@ -562,7 +562,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-atclone-hook [[[
 ____
 
@@ -580,7 +580,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-atpull-e-hook [[[
 ____
 
@@ -597,7 +597,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-atpull-hook [[[
 ____
 
@@ -614,7 +614,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  ]]]
  FUNCTION: ∞zinit-compile-plugin-hook [[[
 ____
@@ -631,7 +631,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-cp-hook [[[
 ____
 
@@ -648,7 +648,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-extract-hook [[[
 ____
 
@@ -663,7 +663,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-make-e-hook [[[
 ____
 
@@ -679,7 +679,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-make-ee-hook [[[
 ____
 
@@ -695,7 +695,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-make-hook [[[
 ____
 
@@ -711,7 +711,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-mv-hook [[[
 ____
 
@@ -729,7 +729,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-ps-on-update-hook [[[
 ____
 
@@ -746,7 +746,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
 ~~~~~~~~~~~~~~~~~
 
 ____
- 
+
  FUNCTION: ∞zinit-reset-opt-hook [[[
 ____
 
@@ -763,16 +763,16 @@ compinit
 ~~~~~~~~
 
 ____
- 
+
  Initialisation for new style completion. This mainly contains some helper
  functions and setup. Everything else is split into different files that
  will automatically be made autoloaded (see the end of this file).  The
  names of the files that will be considered for autoloading are those that
  begin with an underscores (like `_condition).
- 
+
  The first line of each of these files is read and must indicate what
  should be done with its contents:
- 
+
  `#compdef <names ...>'
 ____
 
@@ -783,4 +783,3 @@ Uses feature(s): _autoload_, _bindkey_, _compdef_, _compdump_, _eval_, _read_, _
 Called by:
 
  .zinit-compinit
-