Skip to content

Fix anchor link generation and add example usage to README builder #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ninjaninja140 merged 3 commits into from
Nov 21, 2025
Merged

Fix anchor link generation and add example usage to README builder #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d7ebc1
Initial plan
Copilot Nov 21, 2025
024b626
Add schemas types to fix build
Copilot Nov 21, 2025
d6f9631
Fix anchor links and add example usage to README builder
Copilot Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 172 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,25 @@ A few of the actions or workflows used in this repository are forks of `sapphire

#### Workflows:

* [Node Package Publish](#.github/workflows/Package-Publish.yml)
* [README.md Updater](#.github/workflows/Repository-Update.yml)
* [Build Rojo Project](#.github/workflows/Rojo-Build.yml)
* [Package.json Version Check](#.github/workflows/Version-Check.yml)
* [Cancel Workflow](#.github/workflows/Workflow-Cancel.yml)
* [Node Package Publish](#node-package-publish)
* [README.md Updater](#readme-md-updater)
* [Build Rojo Project](#build-rojo-project)
* [Package.json Version Check](#package-json-version-check)
* [Cancel Workflow](#cancel-workflow)

#### Actions:

* [Install dependencies with Yarn](#actions/add-yarn-dependencies/action.yml)
* [Configure Git CLI](#actions/git-configure/action.yml)
* [Install Aftman](#actions/install-aftman/action.yml)
* [Install dependencies with NPM](#actions/install-npm-dependencies/action.yml)
* [Configure Git CLI](#actions/install-rokit/action.yml)
* [Generate Self-hosted Runner Token](#actions/make-runner/action.yml)
* [Set Memory Swap Space](#actions/set-swap-space/action.yml)
* [Install dependencies with Yarn](#install-dependencies-with-yarn)
* [Configure Git CLI](#configure-git-cli)
* [Install Aftman](#install-aftman)
* [Install dependencies with NPM](#install-dependencies-with-npm)
* [Configure Git CLI](#configure-git-cli)
* [Generate Self-hosted Runner Token](#generate-self-hosted-runner-token)
* [Set Memory Swap Space](#set-memory-swap-space)
## Workflows:
#### [Node Package Publish](#.github/workflows/Package-Publish.yml)
#### [Node Package Publish](#node-package-publish)

* Component link: `Bracketed/Workflows/.github/workflows/Package-Publish.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Package-Publish.yml)
* Component link: `Bracketed/Workflows/.github/workflows/Package-Publish.yml@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/.github/workflows/Package-Publish.yml)
* Description: Publish a node package to the NPM registry

**Inputs:**
Expand Down Expand Up @@ -89,13 +89,39 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `main`
* Type: `string`
#### [README.md Updater](#.github/workflows/Repository-Update.yml)

* Component link: `Bracketed/Workflows/.github/workflows/Repository-Update.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Repository-Update.yml)
**Example Usage:**

name: Example Workflow
on:
push:
branches: [main]

jobs:
example:
uses: Bracketed/Workflows/.github/workflows/Package-Publish.yml@copilot/fix-anchor-links-readme-builder
with:
project-name: @${{ github.repository }}
repository-owner: bracketed
node-version: 23
#### [README.md Updater](#readme-md-updater)

* Component link: `Bracketed/Workflows/.github/workflows/Repository-Update.yml@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/.github/workflows/Repository-Update.yml)
* Description: Automatically updates the README.md file of this repository, this is NOT a reusable workflow
#### [Build Rojo Project](#.github/workflows/Rojo-Build.yml)

* Component link: `Bracketed/Workflows/.github/workflows/Rojo-Build.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Rojo-Build.yml)
**Example Usage:**

name: Example Workflow
on:
push:
branches: [main]

jobs:
example:
uses: Bracketed/Workflows/.github/workflows/Repository-Update.yml@copilot/fix-anchor-links-readme-builder
#### [Build Rojo Project](#build-rojo-project)

* Component link: `Bracketed/Workflows/.github/workflows/Rojo-Build.yml@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/.github/workflows/Rojo-Build.yml)
* Description: Build a Rojo Project with Aftman

**Inputs:**
Expand Down Expand Up @@ -165,9 +191,24 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `true`
* Type: `boolean`
#### [Package.json Version Check](#.github/workflows/Version-Check.yml)

* Component link: `Bracketed/Workflows/.github/workflows/Version-Check.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Version-Check.yml)
**Example Usage:**

name: Example Workflow
on:
push:
branches: [main]

jobs:
example:
uses: Bracketed/Workflows/.github/workflows/Rojo-Build.yml@copilot/fix-anchor-links-readme-builder
with:
project-name: @${{ github.repository }}
project-context: .
project-output: ${{ github.repository_owner }}~${{ github.event.repository.name }}~${GITHUB_SHA:0:7}
#### [Package.json Version Check](#package-json-version-check)

* Component link: `Bracketed/Workflows/.github/workflows/Version-Check.yml@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/.github/workflows/Version-Check.yml)
* Description: Check the package.json version for a new version or same version

**Inputs:**
Expand Down Expand Up @@ -202,9 +243,24 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `${{ github.ref }}`
* Type: `string`
#### [Cancel Workflow](#.github/workflows/Workflow-Cancel.yml)

* Component link: `Bracketed/Workflows/.github/workflows/Workflow-Cancel.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Workflow-Cancel.yml)
**Example Usage:**

name: Example Workflow
on:
push:
branches: [main]

jobs:
example:
uses: Bracketed/Workflows/.github/workflows/Version-Check.yml@copilot/fix-anchor-links-readme-builder
with:
cancel-on-same: false
project-name: @${{ github.repository }}
repository-owner: bracketed
#### [Cancel Workflow](#cancel-workflow)

* Component link: `Bracketed/Workflows/.github/workflows/Workflow-Cancel.yml@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/.github/workflows/Workflow-Cancel.yml)
* Description: Cancel a Github Actions Workflow with the gh CLI

**Inputs:**
Expand All @@ -217,10 +273,24 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `ubuntu-latest`
* Type: `string`

**Example Usage:**

name: Example Workflow
on:
push:
branches: [main]

jobs:
example:
uses: Bracketed/Workflows/.github/workflows/Workflow-Cancel.yml@copilot/fix-anchor-links-readme-builder
with:
repository-owner: bracketed
operating-system: ubuntu-latest
## Actions:
#### [Install dependencies with Yarn](#actions/add-yarn-dependencies/action.yml)
#### [Install dependencies with Yarn](#install-dependencies-with-yarn)

* Component link: `Bracketed/Workflows/actions/add-yarn-dependencies@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/add-yarn-dependencies/action.yml)
* Component link: `Bracketed/Workflows/actions/add-yarn-dependencies@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/add-yarn-dependencies/action.yml)
* Description: Setup Node and install dependencies using Yarn.

**Inputs:**
Expand All @@ -236,19 +306,37 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `23`
* Type: `string`
#### [Configure Git CLI](#actions/git-configure/action.yml)

* Component link: `Bracketed/Workflows/actions/git-configure@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/git-configure/action.yml)
**Example Usage:**

steps:
- name: Install dependencies with Yarn
uses: Bracketed/Workflows/actions/add-yarn-dependencies@copilot/fix-anchor-links-readme-builder
with:
immutable: false
flags:
node-version: 23
#### [Configure Git CLI](#configure-git-cli)

* Component link: `Bracketed/Workflows/actions/git-configure@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/git-configure/action.yml)
* Description: Configure the Git CLI with the correct values and objects for usage in a command line environment

**Inputs:**

* **GITHUB_TOKEN**: The Github Token to utilise when running this action
* Required: `true`
* Type: `string`
#### [Install Aftman](#actions/install-aftman/action.yml)

* Component link: `Bracketed/Workflows/actions/install-aftman@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/install-aftman/action.yml)
**Example Usage:**

steps:
- name: Configure Git CLI
uses: Bracketed/Workflows/actions/git-configure@copilot/fix-anchor-links-readme-builder
with:
GITHUB_TOKEN: ${{ secrets.EXAMPLE_GITHUB_TOKEN }}
#### [Install Aftman](#install-aftman)

* Component link: `Bracketed/Workflows/actions/install-aftman@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/install-aftman/action.yml)
* Description: Github action to install the Aftman toolchain manager - A fork of ok-nic/setup-aftman

**Inputs:**
Expand All @@ -268,9 +356,19 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `${{ github.token }}`
* Type: `string`
#### [Install dependencies with NPM](#actions/install-npm-dependencies/action.yml)

* Component link: `Bracketed/Workflows/actions/install-npm-dependencies@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/install-npm-dependencies/action.yml)
**Example Usage:**

steps:
- name: Install Aftman
uses: Bracketed/Workflows/actions/install-aftman@copilot/fix-anchor-links-readme-builder
with:
version: ${{ secrets.EXAMPLE_VERSION }}
context: .
cache: false
#### [Install dependencies with NPM](#install-dependencies-with-npm)

* Component link: `Bracketed/Workflows/actions/install-npm-dependencies@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/install-npm-dependencies/action.yml)
* Description: Setup Node and install dependencies using NPM.

**Inputs:**
Expand All @@ -286,9 +384,19 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `23`
* Type: `string`
#### [Configure Git CLI](#actions/install-rokit/action.yml)

* Component link: `Bracketed/Workflows/actions/install-rokit@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/install-rokit/action.yml)
**Example Usage:**

steps:
- name: Install dependencies with NPM
uses: Bracketed/Workflows/actions/install-npm-dependencies@copilot/fix-anchor-links-readme-builder
with:
frozen: false
flags:
node-version: 23
#### [Configure Git CLI](#configure-git-cli)

* Component link: `Bracketed/Workflows/actions/install-rokit@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/install-rokit/action.yml)
* Description: Configure the Git CLI with the correct values and objects for usage in a command line environment

**Inputs:**
Expand All @@ -309,9 +417,19 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `.`
* Type: `string`
#### [Generate Self-hosted Runner Token](#actions/make-runner/action.yml)

* Component link: `Bracketed/Workflows/actions/make-runner@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/make-runner/action.yml)
**Example Usage:**

steps:
- name: Configure Git CLI
uses: Bracketed/Workflows/actions/install-rokit@copilot/fix-anchor-links-readme-builder
with:
toolchain-version: stable
rokit-version: latest
self-install: true
#### [Generate Self-hosted Runner Token](#generate-self-hosted-runner-token)

* Component link: `Bracketed/Workflows/actions/make-runner@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/make-runner/action.yml)
* Description: Generate a token for a self-hosted GitHub Actions runner.

**Inputs:**
Expand All @@ -323,9 +441,18 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* **org**: Optional override for the organization name. Defaults to the repository owner.
* Required: `false`
* Type: `string`
#### [Set Memory Swap Space](#actions/set-swap-space/action.yml)

* Component link: `Bracketed/Workflows/actions/set-swap-space@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/set-swap-space/action.yml)
**Example Usage:**

steps:
- name: Generate Self-hosted Runner Token
uses: Bracketed/Workflows/actions/make-runner@copilot/fix-anchor-links-readme-builder
with:
token: ${{ github.token }}
org:
#### [Set Memory Swap Space](#set-memory-swap-space)

* Component link: `Bracketed/Workflows/actions/set-swap-space@copilot/fix-anchor-links-readme-builder` [[Source]](https://github.com/Bracketed/Workflows/blob/copilot/fix-anchor-links-readme-builder/actions/set-swap-space/action.yml)
* Description: Add more swap space for memory in Gigabytes - By `pierotofy/set-swap-space`

**Inputs:**
Expand All @@ -334,9 +461,17 @@ A few of the actions or workflows used in this repository are forks of `sapphire
* Required: `false`
* Default: `10`
* Type: `string`

**Example Usage:**

steps:
- name: Set Memory Swap Space
uses: Bracketed/Workflows/actions/set-swap-space@copilot/fix-anchor-links-readme-builder
with:
swap-size: 10
* * *

_Last Edited by ninjaninja140 at 21/11/2025 in **[09495f2](Bracketed/Workflows.git/commit/09495f2059e51156f48037ee56c159d055d2f0a7)**_
_Last Edited by copilot-swe-agent[bot] at 21/11/2025 in **[024b626](Bracketed/Workflows/commit/024b62683472c13b65cf4a250a0c09ebbfa813e5)**_

- This repo automatically generates its README.md file, feel free to take a look or use the code in this repo!
* * *
Expand Down
Loading
Loading