|
3 | 3 | # GitHub Reusable Workflow: Node.js Release |
4 | 4 |
|
5 | 5 | <div align="center"> |
6 | | - <img src="https://opengraph.githubassets.com/5e6e6522b2be37aede8ce1464ef3152618d5ae56afc61474ac0df95cbf35ec3d/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Node.js Release" /> |
| 6 | + <img src="https://opengraph.githubassets.com/c89abd1b58c683e2ae77a41fcb8cef8b2054b9120306f6d0d6aa1a347afd832b/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Node.js Release" /> |
7 | 7 | </div> |
8 | 8 |
|
9 | 9 | --- |
|
15 | 15 | [](http://choosealicense.com/licenses/mit/) |
16 | 16 | [](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) |
17 | 17 | [](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) |
| 18 | + |
18 | 19 |
|
19 | 20 | <!-- badges:end --> |
20 | 21 | <!-- overview:start --> |
@@ -520,3 +521,52 @@ For more details, see the [license](http://choosealicense.com/licenses/mit/). |
520 | 521 | This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). |
521 | 522 |
|
522 | 523 | <!-- generated:end --> |
| 524 | +<!-- usage:start --> |
| 525 | + |
| 526 | +## Usage |
| 527 | + |
| 528 | +```yaml |
| 529 | +name: Node.js Release |
| 530 | +on: |
| 531 | + push: |
| 532 | + branches: |
| 533 | + - main |
| 534 | +permissions: {} |
| 535 | +jobs: |
| 536 | + release: |
| 537 | + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/release.yml@97f64bc080b78daca8fb3ece49de448aaac83429 # 1.1.0 |
| 538 | + permissions: |
| 539 | + actions: read |
| 540 | + contents: write |
| 541 | + id-token: write |
| 542 | + pull-requests: read |
| 543 | + secrets: |
| 544 | + # Optional complete JSON summary configuration, including provider credentials. Overrides the changelog-summary input and is forwarded unchanged to ci-github-publish/actions/release/create. |
| 545 | + changelog-summary: "" |
| 546 | + with: |
| 547 | + # JSON array containing one public npm package from prepare-package-release. |
| 548 | + # This input is required. |
| 549 | + packages: "" |
| 550 | +
|
| 551 | + # Validated package tarball artifact ID from this workflow run and the prepared tag's commit. Upload one raw .tgz with archive: false. The caller must depend on successful validation; any job can produce the artifact. |
| 552 | + # |
| 553 | + # This input is required. |
| 554 | + package-tarball-artifact-id: "" |
| 555 | +
|
| 556 | + # Project directory relative to the caller repository root, matching release preparation. |
| 557 | + # Default: `.` |
| 558 | + working-directory: . |
| 559 | + |
| 560 | + # Optional JSON configuration forwarded unchanged to ci-github-publish/actions/release/create. |
| 561 | + # Supports all upstream summary options. Use the changelog-summary secret when the configuration contains credentials. |
| 562 | + # A non-empty secret overrides this input; omit both to disable summarization. Summary failures stop publication. |
| 563 | + # See https://github.com/hoverkraft-tech/ci-github-publish/tree/main/actions/release/create. |
| 564 | + changelog-summary: "" |
| 565 | + |
| 566 | + # Optional GitHub environment for release jobs. Leave empty to run without an environment. When set, its protection rules apply; use the same name if restricting npm trusted publishing to an environment. |
| 567 | + environment: "" |
| 568 | +``` |
| 569 | +
|
| 570 | +<!-- usage:end --> |
| 571 | +<!-- examples:start --> |
| 572 | +<!-- examples:end --> |
0 commit comments