Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cssnr/parse-issue-form-action
Parse Issue Form Action
https://github.com/cssnr/parse-issue-form-action
actions
Last synced: 6 days ago
JSON representation
Parse Issue Form Action
- Host: GitHub
- URL: https://github.com/cssnr/parse-issue-form-action
- Owner: cssnr
- License: gpl-3.0
- Created: 2024-07-05T04:36:21.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-07-26T20:35:28.000Z (4 months ago)
- Last Synced: 2024-07-27T03:33:55.917Z (4 months ago)
- Topics: actions
- Language: JavaScript
- Homepage: https://cssnr.github.io
- Size: 283 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/cssnr/parse-issue-form-action/actions/workflows/tags.yaml)
[](https://github.com/cssnr/parse-issue-form-action/actions/workflows/test.yaml)
[](https://sonarcloud.io/summary/new_code?id=cssnr_parse-issue-form-action)
[](https://github.com/cssnr/parse-issue-form-action/releases/latest)
[](https://github.com/cssnr/parse-issue-form-action/graphs/commit-activity)
[](https://codeberg.org/cssnr/parse-issue-form-action)
[](https://github.com/cssnr/parse-issue-form-action)
[](https://cssnr.github.io/)
[](https://discord.gg/wXy6m2X8wY)
# Parse Issue Form Action
Parse GitHub Issue Forms Action and Set as Outputs.
This is a zero configuration way to get a form value as an Output.
This is currently a WIP but functional.
- [Inputs](#Inputs)
- [Outputs](#Outputs)
- [Examples](#Examples)
- [Known Issues](#Known-Issues)
- [Support](#Support)
- [Contributing](#Contributing)
> [!NOTE]
> Please submit
> a [Feature Request](https://github.com/cssnr/parse-issue-form-action/discussions/categories/feature-requests)
> for new features or [Open an Issue](https://github.com/cssnr/parse-issue-form-action/issues) if you find any bugs.
## Inputs
| input | required | default | description |
| ----- | -------- | ------- | -------------------------------------------- |
| body | Yes | - | Set this to `${{ github.event.issue.body }}` |
```yaml
- name: 'Parse Issue'
id: issue
uses: cssnr/parse-issue-form-action@v1
with:
body: ${{ github.event.issue.body }}
```
## Outputs
Outputs are headings/labels, to lower case, with spaces replaced with `_`'s.
A heading/label of `Site Link` will be an output with key `site_link`.
> [!WARNING]
> This only parses values as strings and will not parse check boxes or dropdowns correctly.
> Once I have a use or request for this feature, the functionality will be added...
## Examples
Using this issue form template:
```yaml
name: 'Issue'
description: 'Open an Issue'
body:
- type: input
id: url
attributes:
label: Site URL
description: Enter a URL
- type: textarea
id: description
attributes:
label: Details
description: Please describe the issue...
```
Will generate these 2 outputs:
- `${{ steps.issue.outputs.site_url }}`
- `${{ steps.issue.outputs.details }}`
```yaml
name: 'Issue'
on:
issues:
types:
- opened
jobs:
issue:
name: 'Issue'
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: 'Checkout'
uses: actions/checkout@v4
- name: 'Debug Issue'
run: |
echo Issue number: '${{ github.event.issue.number }}'
echo Issue title: '${{ github.event.issue.title }}'
echo Issue body: '${{ github.event.issue.body }}'
- name: 'Parse Issue'
id: issue
uses: cssnr/parse-issue-form-action@v1
with:
body: ${{ github.event.issue.body }}
- name: 'Debug Parsed Issue'
run: |
echo Site Link: '${{ steps.issue.outputs.site_link }}'
echo Details: '${{ steps.issue.outputs.details }}'
```
For a full example, see: https://github.com/cssnr/link-extractor/blob/master/.github/workflows/issue.yaml
## Known Issues
- As previously mentioned, this currently parses raw content, therefore, will not parse check box/dropdown values,
yet...
- If a users uses `###` at the start of a line, it would be interpreted as an output. Will be fixed if an issue is
opened.
- If you use an IDE to validate actions, it will display the outputs as invalid since outputs are arbitrary based on
input.
This is a very simple action, for more details see: [src/index.js](src%2Findex.js)
# Support
For general help or to request a feature, see:
- Q&A Discussion: https://github.com/cssnr/parse-issue-form-action/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/parse-issue-form-action/discussions/categories/feature-requests
If you are experiencing an issue/bug or getting unexpected results, you can:
- Report an Issue: https://github.com/cssnr/parse-issue-form-action/issues
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
- Provide General
Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Parse%20Issue%20Form)
# Contributing
Currently, the best way to contribute to this project is to star this project on GitHub.
Additionally, you can support other GitHub Actions I have published:
- [VirusTotal Action](https://github.com/cssnr/virustotal-action)
- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action)
- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action)
- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action)
- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action)
- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action)
For a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/)