From c2d45bd3eff96a93679cc5dbac166c5a14400751 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Tue, 28 Oct 2025 02:12:53 +0000 Subject: [PATCH] docs(readme): fix outdated action inputs/outputs (#26) --- .github/release-please-config.json | 14 +++++++++++ README.md | 39 ++++++++++++++++++------------ 2 files changed, 37 insertions(+), 16 deletions(-) diff --git a/.github/release-please-config.json b/.github/release-please-config.json index c5fa819..2282853 100644 --- a/.github/release-please-config.json +++ b/.github/release-please-config.json @@ -12,5 +12,19 @@ "include-component-in-tag": false } }, + "changelog-sections": [ + { "type": "feat", "section": "Features" }, + { "type": "feature", "section": "Features" }, + { "type": "fix", "section": "Bug Fixes" }, + { "type": "perf", "section": "Performance Improvements" }, + { "type": "revert", "section": "Reverts" }, + { "type": "docs", "section": "Documentation", "hidden": false }, + { "type": "style", "section": "Styles", "hidden": true }, + { "type": "chore", "section": "Miscellaneous Chores", "hidden": true }, + { "type": "refactor", "section": "Code Refactoring", "hidden": true }, + { "type": "test", "section": "Tests", "hidden": true }, + { "type": "build", "section": "Build System", "hidden": true }, + { "type": "ci", "section": "Continuous Integration", "hidden": true } + ], "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json" } diff --git a/README.md b/README.md index 51ca6bb..361c957 100644 --- a/README.md +++ b/README.md @@ -100,30 +100,37 @@ jobs: - + ## Inputs -| parameter | description | required | default | -| ------------ | --------------------------------------------------------------------------------- | -------- | ------------------- | -| tags | List/CSV of tags to create/update. | `true` | | -| ref | The SHA or ref to tag. Defaults to SHA of current commit. | `false` | ${{ github.sha }} | -| when_exists | What to do if the tag already exists. Must be one of 'update', 'skip', or 'fail'. | `false` | update | -| github_token | The GitHub token to use for authentication. | `false` | ${{ github.token }} | +| name | description | required | default | +| -------------- | --------------------------------------------------------------------------------------------------------------------- | -------- | --------------------- | +| `tags` |

List/CSV of tags to create/update.

| `true` | `""` | +| `ref` |

The SHA or ref to tag. Defaults to SHA of current commit.

| `false` | `${{ github.sha }}` | +| `when_exists` |

What to do if the tag already exists. Must be one of 'update', 'skip', or 'fail'.

| `false` | `update` | +| `annotation` |

Optional annotation message for tags. If provided, creates annotated tags. If empty, creates lightweight tags.

| `false` | `""` | +| `github_token` |

The GitHub token to use for authentication.

| `false` | `${{ github.token }}` | - - - + + ## Outputs -| parameter | description | -| --------- | --------------------------------------- | -| tags | List of tags that were created/updated. | -| created | List of tags that were created. | -| updated | List of tags that were updated. | +| name | description | +| --------- | ---------------------------------------------- | +| `tags` |

List of tags that were created/updated.

| +| `created` |

List of tags that were created.

| +| `updated` |

List of tags that were updated.

| - + + + +## Runs + +This action is a `node24` action. + + ## License