|
@@ -14,7 +14,29 @@ The wiki repository holds all documentation while the wiki-ui repository is the
|
|
|
|
|
|
== Wiki
|
|
|
|
|
|
-The wiki repository has a workflow that will be triggered when any push is made to the repository or whenever the user interface issues a new release. Every build, all pages are deleted and re-created. The workflow will cache the user interface under the `menu:cache[antora]` directory if there are any changes. This cache allows the build process to run offline.
|
|
|
+The wiki repository has a workflow that will be triggered when any push is made to the repository or whenever the user interface issues a new release. Every build, all pages are deleted and re-created. The workflow will cache the user interface under the `menu:cache[antora]` directory if there are any changes and the cache and the folder has been added to the commit command.
|
|
|
+
|
|
|
+[source, yml]
|
|
|
+----
|
|
|
+ # Detects any updates to package-lock.json and package.json and commits the
|
|
|
+ # files to root.
|
|
|
+ # see:
|
|
|
+ # https://github.com/marketplace/actions/add-commit?version=v4.1.0
|
|
|
+ # for use options.
|
|
|
+ - name: Commit Packages
|
|
|
+ uses: EndBug/add-and-commit@v4
|
|
|
+ with:
|
|
|
+ author_name: mitm001
|
|
|
+ author_email: [email protected]
|
|
|
+ message: "Commit files for CI workflow"
|
|
|
+ # Commits these files to root if and only if there are changes.
|
|
|
+ add: "package-lock.json package.json ./.cache/antora/*"
|
|
|
+ env:
|
|
|
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
+----
|
|
|
+
|
|
|
+
|
|
|
+This cache allows the build process to run offline.
|
|
|
|
|
|
The workflow can be configured to update the `package-lock` and `package.json` files by editing the `Install node` command, just as if you were running this from a local repo.
|
|
|
|
|
@@ -106,7 +128,7 @@ Branch version names should only target major/minor releases, not the patch of a
|
|
|
When it's time to cut a new version for the wiki, the process is as follows.
|
|
|
|
|
|
. Create and checkout a new branch that matches the *current version* of the wiki. If the current version (HEAD) is targeting version 3.3 in the `antora.yml` for example, you would name the new branch `v3.3`. Thereby preserving the current master branch content.
|
|
|
-. We do not want the Antora `.cache` to be versioned so you need to delete it from the new version branch if it has been commited to the repo.
|
|
|
+. We do not want the Antora `.cache` to be versioned so you need to delete it from the new version branch if it has been commited to the repo.
|
|
|
. Push the branch to the repository.
|
|
|
. Switch to the `master` branch and edit these files:
|
|
|
.. Add the newly created branch to the `branches:` array in `wiki-playbook.yml`.
|