Skip to content

Commit 3039aee

Browse files
hoverkraft-bot[bot]neilime
authored andcommitted
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 516d509 commit 3039aee

File tree

10 files changed

+90
-39
lines changed

10 files changed

+90
-39
lines changed

.github/workflows/clean-deploy.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,9 @@ Behavior / outputs:
4343
### Permissions
4444

4545
- **`actions`**: `read`
46-
- **`contents`**: `write`
4746
- **`deployments`**: `write`
4847
- **`id-token`**: `write`
4948
- **`issues`**: `write`
50-
- **`packages`**: `write`
5149
- **`pull-requests`**: `write`
5250

5351
<!-- overview:end -->
@@ -66,14 +64,7 @@ permissions: {}
6664
jobs:
6765
clean-deploy:
6866
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy.yml@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
69-
permissions:
70-
contents: write
71-
issues: write
72-
packages: write
73-
pull-requests: write
74-
actions: read
75-
deployments: write
76-
id-token: write
67+
permissions: {}
7768
secrets:
7869
# GitHub token for deploying.
7970
# Permissions:

.github/workflows/deploy-chart.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ jobs:
9494
issues: write
9595
packages: write
9696
pull-requests: write
97-
id-token: write
9897
secrets:
9998
# OCI registry password.
10099
# This input is required.

.github/workflows/deploy-checks.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,8 @@ on:
5151
permissions: {}
5252
jobs:
5353
deploy-checks:
54-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-checks.yml@ecafdeac18a6a6dcc01058cd53ac7431bedb5c3b # 0.14.1
55-
permissions:
56-
contents: read
57-
id-token: write
54+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-checks.yml@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
55+
permissions: {}
5856
with:
5957
# JSON array of runner(s) to use.
6058
# See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.

.github/workflows/deploy-finish.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,6 @@ What this workflow does:
4444
- **`contents`**: `read`
4545
- **`deployments`**: `write`
4646
- **`id-token`**: `write`
47-
- **`issues`**: `read`
48-
- **`pull-requests`**: `write`
4947

5048
<!-- overview:end -->
5149

@@ -62,14 +60,8 @@ on:
6260
permissions: {}
6361
jobs:
6462
deploy-finish:
65-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-finish.yml@ecafdeac18a6a6dcc01058cd53ac7431bedb5c3b # 0.14.1
66-
permissions:
67-
contents: read
68-
issues: read
69-
pull-requests: write
70-
actions: read
71-
deployments: write
72-
id-token: write
63+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-finish.yml@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
64+
permissions: {}
7365
with:
7466
# JSON array of runner(s) to use.
7567
# See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.

.github/workflows/deploy-start.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@ Environment:
4747

4848
### Permissions
4949

50-
- **`actions`**: `read`
5150
- **`deployments`**: `write`
5251
- **`id-token`**: `write`
5352
- **`issues`**: `write`
54-
- **`pull-requests`**: `write`
5553

5654
<!-- overview:end -->
5755

@@ -68,13 +66,8 @@ on:
6866
permissions: {}
6967
jobs:
7068
deploy-start:
71-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-start.yml@ecafdeac18a6a6dcc01058cd53ac7431bedb5c3b # 0.14.1
72-
permissions:
73-
actions: read
74-
deployments: write
75-
issues: write
76-
pull-requests: write
77-
id-token: write
69+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-start.yml@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
70+
permissions: {}
7871
with:
7972
# JSON array of runner(s) to use.
8073
# See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.

.github/workflows/prepare-release.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Reusable workflow that performs release preparation tasks:
3535
### Permissions
3636

3737
- **`contents`**: `read`
38+
- **`id-token`**: `write`
3839
- **`pull-requests`**: `write`
3940

4041
<!-- overview:end -->

.github/workflows/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ on:
4343
permissions: {}
4444
jobs:
4545
release:
46-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/release.yml@418e2c3d36cd1ccabf8c15a5c5c3c4c7b146227f # main
46+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/release.yml@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
4747
permissions: {}
4848
with:
4949
# JSON array of runner(s) to use.

actions/deploy/github-pages/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ permissions:
4747
## Usage
4848
4949
```yaml
50-
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@275b6d8500449d5653bce59c799e4f54c072929d # 0.15.0
50+
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
5151
with:
5252
# The path to the assets to deploy.
5353
# Can be absolute or relative $GITHUB_WORKSPACE.
@@ -68,7 +68,7 @@ permissions:
6868
# Permissions:
6969
# - pages: write
7070
# - id-token: write
71-
# See https://github.com/actions/configure-pages.
71+
# See https://github.com/actions/deploy-pages.
7272
#
7373
# Default: `${{ github.token }}`
7474
github-token: ${{ github.token }}
@@ -92,7 +92,7 @@ permissions:
9292
| | Permissions: | | |
9393
| | - pages: write | | |
9494
| | - id-token: write | | |
95-
| | See <https://github.com/actions/configure-pages>. | | |
95+
| | See <https://github.com/actions/deploy-pages>. | | |
9696

9797
<!-- inputs:end -->
9898

actions/release/get-configuration/README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,68 @@
11
<!-- header:start -->
2+
3+
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYm9va21hcmsiIGNvbG9yPSJibHVlIj48cGF0aCBkPSJNMTkgMjFsLTctNS03IDVWNWEyIDIgMCAwIDEgMi0yaDEwYTIgMiAwIDAgMSAyIDJ6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Deployment - Create Release
4+
5+
<div align="center">
6+
<img src="../../../.github/logo.svg" width="60px" align="center" alt="Deployment - Create Release" />
7+
</div>
8+
9+
---
10+
211
<!-- header:end -->
312
<!-- badges:start -->
13+
14+
[![Marketplace](https://img.shields.io/badge/Marketplace-deployment------create--release-blue?logo=github-actions)](https://github.com/marketplace/actions/deployment---create-release)
15+
[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-publish)](https://github.com/hoverkraft-tech/ci-github-publish/releases)
16+
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-publish)](http://choosealicense.com/licenses/mit/)
17+
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-publish?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-publish?style=social)
18+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-publish/blob/main/CONTRIBUTING.md)
19+
420
<!-- badges:end -->
521
<!-- overview:start -->
22+
23+
## Overview
24+
25+
Action to create a new release
26+
627
<!-- overview:end -->
728
<!-- usage:start -->
29+
30+
## Usage
31+
32+
```yaml
33+
- uses: hoverkraft-tech/ci-github-publish/actions/release/get-configuration@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
34+
with:
35+
# Working directory for monorepo support.
36+
# If specified, the release configuration file will be placed in `.github/release-configs/{slug}.yml` where slug is derived from the working directory path.
37+
# The configuration will include `include-paths` to filter pull requests to only those that modified files in the specified directory.
38+
working-directory: ""
39+
```
40+
841
<!-- usage:end -->
942
<!-- inputs:start -->
43+
44+
## Inputs
45+
46+
| **Input** | **Description** | **Required** | **Default** |
47+
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
48+
| **`working-directory`** | Working directory for monorepo support. | **false** | - |
49+
| | If specified, the release configuration file will be placed in `.github/release-configs/{slug}.yml` where slug is derived from the working directory path. | | |
50+
| | The configuration will include `include-paths` to filter pull requests to only those that modified files in the specified directory. | | |
51+
1052
<!-- inputs:end -->
1153
<!-- outputs:start -->
54+
55+
## Outputs
56+
57+
| **Output** | **Description** |
58+
| ----------------------- | ---------------------------------------------------------------------------------- |
59+
| **`working-directory`** | The working directory used for the release. |
60+
| | Relative to the repository root. |
61+
| | Empty if not set. |
62+
| **`config-slug`** | The slug derived from the working directory. Empty if no working directory is set. |
63+
| **`config-name`** | The name of the release configuration file |
64+
| **`config-path`** | The path to the release configuration file |
65+
1266
<!-- outputs:end -->
1367
<!-- secrets:start -->
1468
<!-- secrets:end -->
@@ -18,12 +72,33 @@
1872
// jscpd:ignore-start
1973
-->
2074
<!-- contributing:start -->
75+
76+
## Contributing
77+
78+
Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-publish/blob/main/CONTRIBUTING.md) for more details.
79+
2180
<!-- contributing:end -->
2281
<!-- security:start -->
2382
<!-- security:end -->
2483
<!-- license:start -->
84+
85+
## License
86+
87+
This project is licensed under the MIT License.
88+
89+
SPDX-License-Identifier: MIT
90+
91+
Copyright © 2025 hoverkraft
92+
93+
For more details, see the [license](http://choosealicense.com/licenses/mit/).
94+
2595
<!-- license:end -->
2696
<!-- generated:start -->
97+
98+
---
99+
100+
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
101+
27102
<!-- generated:end -->
28103
<!--
29104
// jscpd:ignore-end

actions/workflow/get-workflow-failure/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,16 @@ Each failed job entry contains the job name, its conclusion, and the job web URL
3838
Note: this action reads jobs for the current run and therefore relies on the workflow run context;
3939
the default `GITHUB_TOKEN` already has read access to Actions in typical workflows.
4040

41+
It requires the `actions: read` permission on the token used.
42+
4143
<!-- overview:end -->
4244

4345
<!-- usage:start -->
4446

4547
## Usage
4648

4749
```yaml
48-
- uses: hoverkraft-tech/ci-github-publish/actions/workflow/get-workflow-failure@ecafdeac18a6a6dcc01058cd53ac7431bedb5c3b # 0.14.1
50+
- uses: hoverkraft-tech/ci-github-publish/actions/workflow/get-workflow-failure@ed864a88ec8610dc2a1b9aab1dbde2864bf75df4 # 0.16.0
4951
with:
5052
# GitHub Token to get workflow information.
5153
# Permissions:

0 commit comments

Comments
 (0)