Skip to content

Commit a707ac8

Browse files
Merge pull request #1 from Bracketed/copilot/fix-anchor-links-readme-builder
2 parents 09f597e + d6f9631 commit a707ac8

28 files changed

Lines changed: 921 additions & 703 deletions

README.md

Lines changed: 172 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,25 @@ A few of the actions or workflows used in this repository are forks of `sapphire
2727

2828
#### Workflows:
2929

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

3636
#### Actions:
3737

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

48-
* Component link: `Bracketed/Workflows/.github/workflows/Package-Publish.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Package-Publish.yml)
48+
* 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)
4949
* Description: Publish a node package to the NPM registry
5050

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

94-
* Component link: `Bracketed/Workflows/.github/workflows/Repository-Update.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Repository-Update.yml)
93+
**Example Usage:**
94+
95+
name: Example Workflow
96+
on:
97+
push:
98+
branches: [main]
99+
100+
jobs:
101+
example:
102+
uses: Bracketed/Workflows/.github/workflows/Package-Publish.yml@copilot/fix-anchor-links-readme-builder
103+
with:
104+
project-name: @${{ github.repository }}
105+
repository-owner: bracketed
106+
node-version: 23
107+
#### [README.md Updater](#readme-md-updater)
108+
109+
* 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)
95110
* Description: Automatically updates the README.md file of this repository, this is NOT a reusable workflow
96-
#### [Build Rojo Project](#.github/workflows/Rojo-Build.yml)
97111

98-
* Component link: `Bracketed/Workflows/.github/workflows/Rojo-Build.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Rojo-Build.yml)
112+
**Example Usage:**
113+
114+
name: Example Workflow
115+
on:
116+
push:
117+
branches: [main]
118+
119+
jobs:
120+
example:
121+
uses: Bracketed/Workflows/.github/workflows/Repository-Update.yml@copilot/fix-anchor-links-readme-builder
122+
#### [Build Rojo Project](#build-rojo-project)
123+
124+
* 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)
99125
* Description: Build a Rojo Project with Aftman
100126

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

170-
* Component link: `Bracketed/Workflows/.github/workflows/Version-Check.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Version-Check.yml)
195+
**Example Usage:**
196+
197+
name: Example Workflow
198+
on:
199+
push:
200+
branches: [main]
201+
202+
jobs:
203+
example:
204+
uses: Bracketed/Workflows/.github/workflows/Rojo-Build.yml@copilot/fix-anchor-links-readme-builder
205+
with:
206+
project-name: @${{ github.repository }}
207+
project-context: .
208+
project-output: ${{ github.repository_owner }}~${{ github.event.repository.name }}~${GITHUB_SHA:0:7}
209+
#### [Package.json Version Check](#package-json-version-check)
210+
211+
* 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)
171212
* Description: Check the package.json version for a new version or same version
172213

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

207-
* Component link: `Bracketed/Workflows/.github/workflows/Workflow-Cancel.yml@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/.github/workflows/Workflow-Cancel.yml)
247+
**Example Usage:**
248+
249+
name: Example Workflow
250+
on:
251+
push:
252+
branches: [main]
253+
254+
jobs:
255+
example:
256+
uses: Bracketed/Workflows/.github/workflows/Version-Check.yml@copilot/fix-anchor-links-readme-builder
257+
with:
258+
cancel-on-same: false
259+
project-name: @${{ github.repository }}
260+
repository-owner: bracketed
261+
#### [Cancel Workflow](#cancel-workflow)
262+
263+
* 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)
208264
* Description: Cancel a Github Actions Workflow with the gh CLI
209265

210266
**Inputs:**
@@ -217,10 +273,24 @@ A few of the actions or workflows used in this repository are forks of `sapphire
217273
* Required: `false`
218274
* Default: `ubuntu-latest`
219275
* Type: `string`
276+
277+
**Example Usage:**
278+
279+
name: Example Workflow
280+
on:
281+
push:
282+
branches: [main]
283+
284+
jobs:
285+
example:
286+
uses: Bracketed/Workflows/.github/workflows/Workflow-Cancel.yml@copilot/fix-anchor-links-readme-builder
287+
with:
288+
repository-owner: bracketed
289+
operating-system: ubuntu-latest
220290
## Actions:
221-
#### [Install dependencies with Yarn](#actions/add-yarn-dependencies/action.yml)
291+
#### [Install dependencies with Yarn](#install-dependencies-with-yarn)
222292

223-
* Component link: `Bracketed/Workflows/actions/add-yarn-dependencies@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/add-yarn-dependencies/action.yml)
293+
* 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)
224294
* Description: Setup Node and install dependencies using Yarn.
225295

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

241-
* Component link: `Bracketed/Workflows/actions/git-configure@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/git-configure/action.yml)
310+
**Example Usage:**
311+
312+
steps:
313+
- name: Install dependencies with Yarn
314+
uses: Bracketed/Workflows/actions/add-yarn-dependencies@copilot/fix-anchor-links-readme-builder
315+
with:
316+
immutable: false
317+
flags:
318+
node-version: 23
319+
#### [Configure Git CLI](#configure-git-cli)
320+
321+
* 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)
242322
* Description: Configure the Git CLI with the correct values and objects for usage in a command line environment
243323

244324
**Inputs:**
245325

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

251-
* Component link: `Bracketed/Workflows/actions/install-aftman@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/install-aftman/action.yml)
330+
**Example Usage:**
331+
332+
steps:
333+
- name: Configure Git CLI
334+
uses: Bracketed/Workflows/actions/git-configure@copilot/fix-anchor-links-readme-builder
335+
with:
336+
GITHUB_TOKEN: ${{ secrets.EXAMPLE_GITHUB_TOKEN }}
337+
#### [Install Aftman](#install-aftman)
338+
339+
* 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)
252340
* Description: Github action to install the Aftman toolchain manager - A fork of ok-nic/setup-aftman
253341

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

273-
* Component link: `Bracketed/Workflows/actions/install-npm-dependencies@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/install-npm-dependencies/action.yml)
360+
**Example Usage:**
361+
362+
steps:
363+
- name: Install Aftman
364+
uses: Bracketed/Workflows/actions/install-aftman@copilot/fix-anchor-links-readme-builder
365+
with:
366+
version: ${{ secrets.EXAMPLE_VERSION }}
367+
context: .
368+
cache: false
369+
#### [Install dependencies with NPM](#install-dependencies-with-npm)
370+
371+
* 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)
274372
* Description: Setup Node and install dependencies using NPM.
275373

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

291-
* Component link: `Bracketed/Workflows/actions/install-rokit@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/install-rokit/action.yml)
388+
**Example Usage:**
389+
390+
steps:
391+
- name: Install dependencies with NPM
392+
uses: Bracketed/Workflows/actions/install-npm-dependencies@copilot/fix-anchor-links-readme-builder
393+
with:
394+
frozen: false
395+
flags:
396+
node-version: 23
397+
#### [Configure Git CLI](#configure-git-cli)
398+
399+
* 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)
292400
* Description: Configure the Git CLI with the correct values and objects for usage in a command line environment
293401

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

314-
* Component link: `Bracketed/Workflows/actions/make-runner@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/make-runner/action.yml)
421+
**Example Usage:**
422+
423+
steps:
424+
- name: Configure Git CLI
425+
uses: Bracketed/Workflows/actions/install-rokit@copilot/fix-anchor-links-readme-builder
426+
with:
427+
toolchain-version: stable
428+
rokit-version: latest
429+
self-install: true
430+
#### [Generate Self-hosted Runner Token](#generate-self-hosted-runner-token)
431+
432+
* 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)
315433
* Description: Generate a token for a self-hosted GitHub Actions runner.
316434

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

328-
* Component link: `Bracketed/Workflows/actions/set-swap-space@main` [[Source]](https://github.com/Bracketed/Workflows/blob/main/actions/set-swap-space/action.yml)
445+
**Example Usage:**
446+
447+
steps:
448+
- name: Generate Self-hosted Runner Token
449+
uses: Bracketed/Workflows/actions/make-runner@copilot/fix-anchor-links-readme-builder
450+
with:
451+
token: ${{ github.token }}
452+
org:
453+
#### [Set Memory Swap Space](#set-memory-swap-space)
454+
455+
* 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)
329456
* Description: Add more swap space for memory in Gigabytes - By `pierotofy/set-swap-space`
330457

331458
**Inputs:**
@@ -334,9 +461,17 @@ A few of the actions or workflows used in this repository are forks of `sapphire
334461
* Required: `false`
335462
* Default: `10`
336463
* Type: `string`
464+
465+
**Example Usage:**
466+
467+
steps:
468+
- name: Set Memory Swap Space
469+
uses: Bracketed/Workflows/actions/set-swap-space@copilot/fix-anchor-links-readme-builder
470+
with:
471+
swap-size: 10
337472
* * *
338473

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

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

0 commit comments

Comments
 (0)