Add docs

Author: AndyRae

.github/workflows/semantic-release.yml

@@ -6,7 +6,7 @@ on:
       node-version:
         description: 'Node.js version to use'
         required: false
-        default: '20'
+        default: '24'
         type: string
 
 permissions:

docs/dependency-review.md

@@ -0,0 +1,29 @@
+# Dependency Review
+
+Reusable workflow that runs [Dependency Review](https://github.com/actions/dependency-review-action) on pull requests. It checks dependency changes (e.g. in `package.json`, `package-lock.json`, `Pipfile`, `go.sum`) for known vulnerabilities and license issues.
+
+## Inputs
+
+None.
+
+## Secrets
+
+- `GITHUB_TOKEN` — Pass with `secrets: inherit` so the action can read the repo and comment on the PR.
+
+## Usage
+
+In your repo, add a workflow that runs on pull requests:
+
+```yaml
+name: Dependency Review
+
+on:
+  pull_request:
+
+jobs:
+  dependency-review:
+    uses: health-informatics-uon/workflows/.github/workflows/dependency-review.yml@main
+    secrets: inherit
+```
+
+Replace `@main` with the branch where this reusable workflow is defined.

docs/pr-title.md

@@ -0,0 +1,29 @@
+# PR Title Check
+
+Reusable workflow that validates pull request titles using [action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request). Titles must follow a conventional-commit style (e.g. `feat: add login`, `fix: resolve crash`).
+
+## Inputs
+
+None.
+
+## Secrets
+
+- `GITHUB_TOKEN` — Pass with `secrets: inherit` so the action can read the PR and post status checks.
+
+## Usage
+
+In your repo, add a workflow that runs on pull requests:
+
+```yaml
+name: PR Title Check
+
+on:
+  pull_request:
+
+jobs:
+  pr-title:
+    uses: health-informatics-uon/workflows/.github/workflows/pr-title.yml@main
+    secrets: inherit
+```
+
+Replace `@main` with the branch where this reusable workflow is defined.

docs/semantic-release.md

@@ -0,0 +1,53 @@
+# Semantic Release
+
+Reusable workflow that runs [semantic-release](https://github.com/semantic-release/semantic-release) to determine the next version from commits and publish a GitHub release. Expects a [semantic-release config](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md) (e.g. `release.config.js` or `.releaserc`) in the calling repository.
+
+## Inputs
+
+| Input           | Required | Default | Description                |
+|----------------|----------|---------|----------------------------|
+| `node-version` | No       | `'24'`  | Node.js version to use.    |
+
+## Secrets
+
+- `GITHUB_TOKEN` — Pass with `secrets: inherit` (or set explicitly) so the workflow can create releases and comment on PRs/issues.
+
+## Usage
+
+In your repo, add a workflow that runs on push to `main` (or your release branch):
+
+```yaml
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    uses: health-informatics-uon/workflows/.github/workflows/semantic-release.yml@main
+    with:
+      node-version: '24'   # optional
+    secrets: inherit
+```
+
+Ensure the branch in `@main` matches the branch where this reusable workflow is defined.
+
+`release.config.js`
+
+```json copy
+module.exports = {
+    "branches": ["main"],
+    "tagFormat": "${version}",
+    "preset": "angular",
+    "repositoryUrl": "https://github.com/Health-Informatics-UoN/nuh-helper.git",
+    plugins: [
+      '@semantic-release/commit-analyzer',
+      '@semantic-release/release-notes-generator',
+      '@semantic-release/exec',
+      '@semantic-release/github',
+    ],
+    "initialVersion": "0.0.1"
+};
+```