Update the GitHub action documentation
To indicate which Jenkins pipelines are replaced by the new workflow.
-# GHA workflow
+# GitHub Actions Workflow
+
+The workflow in the [build.yaml](build.yaml) file replaces the existing [Jenkins.ci](../../Jenkinsfile.ci) build process.
+
+The `lint` job replaces the `Static code validation` stage of the Jenkins pipeline, while the remainder of the jobs replace the `Build / Test` stage.
+
+The `Build result notification` stage was not moved to GHA, as build failures will be reports via GHA.
+
+Support for Windows continues as a `ToDo` item.
+
+
+## Configuring actions
If you are cloning or forking this repo you will need to configure two secrets for Actions to run correctly.
@@ -7,7 +18,7 @@ Secrets can be set via Settings -> Secrets -> New repository secret:
`CR_USER`: is your GH username. It must be lowercase.
`CR_PAT`: can be created by following the [Creating a personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) documentation.
-When you create your token, the only permission you need to select is `write:packages` **Upload packages to github package registry**, all other necessary permissions will be selected by default.
+When you create your token, the only permission you need to select is `write:packages` **Upload packages to GitHub package registry**, all other necessary permissions will be selected by default.
You may also need to enable [Improved container support](https://docs.github.com/en/packages/guides/enabling-improved-container-support) in order to allow the images to be written to your repository. You'll see an error to this affect if this is the case.
