https://github.com/peter-murray/github-issue-metadata-action
https://github.com/peter-murray/github-issue-metadata-action
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/peter-murray/github-issue-metadata-action
- Owner: peter-murray
- License: mit
- Created: 2024-07-30T08:17:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T13:28:18.000Z (almost 2 years ago)
- Last Synced: 2026-03-30T08:55:33.426Z (4 months ago)
- Language: TypeScript
- Size: 408 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-issue-metadata-action
This action exists to inject and extract metadata hidden inside an Issue body contents.
## set-metadata
An action that will allow you to set some metadata into an issue.
### Parameters
* `github_token`: GitHub token used for access, defaults to `${{ github.token }}`
* `repository`: Optional repository full name, i.e. `/` for the repositoryt hat hosts the issues, defaults to `${{ github.repository }}`
* `issue_number`: The issue number that will be used to store the metadata
* `metadata_marker`: Optional metadata marker/key name for the metadata object, defaults to `bootstrap`.
* `metadata_value`: The actual string value to set for the value of the metadata
* `github_api_url`: Optional GitHub API URL to use for accessing the issue, defaults to the `${{ github.api_url}}` from the actions runtime
## get-metadata
An action that will fetch any existing metadata from an issue.
### Parameters
* `github_token`: GitHub token used for access, defaults to `${{ github.token }}`
* `repository`: Optional repository full name, i.e. `/` for the repositoryt hat hosts the issues, defaults to `${{ github.repository }}`
* `issue_number`: The issue number that will be used to store the metadata
* `metadata_marker`: Optional metadata marker/key name for the metadata object, defaults to `bootstrap`.
* `metadata_parse_json_payload`: A boolean flag that will further parse the content for the marker metadata as JSON and then provide outputs for each key in the data under `metadata_value_` in the outputs
* `github_api_url`: Optional GitHub API URL to use for accessing the issue, defaults to the `${{ github.api_url}}` from the actions runtime
### Outputs
* `metadata_value`: The string value of the metadata sorted in the marker
* `metadata_value_`: The additional key based metadata values if the `metadata_parse_json_payload` is set to `true`.