https://github.com/peter-evans/jira2md
A GitHub action to convert between Jira text formatting and GitHub flavored markdown
https://github.com/peter-evans/jira2md
Last synced: 9 months ago
JSON representation
A GitHub action to convert between Jira text formatting and GitHub flavored markdown
- Host: GitHub
- URL: https://github.com/peter-evans/jira2md
- Owner: peter-evans
- License: mit
- Created: 2023-11-08T15:15:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T07:52:10.000Z (over 1 year ago)
- Last Synced: 2024-10-05T11:41:44.181Z (over 1 year ago)
- Language: JavaScript
- Size: 407 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jira2md
[](https://github.com/peter-evans/jira2md/actions?query=workflow%3ACI)
A GitHub action to convert between Jira text formatting and GitHub flavored markdown
This action is a wrapper around the [jira2md](https://github.com/kylefarris/J2M) npm package.
## Usage
### Convert Jira -> markdown
```yml
- uses: peter-evans/jira2md@v2
id: jira2md
with:
input-text: |
*Some bold things**
_Some italic stuff_
h2. H2
[http://google.com]
- run: echo "${{ steps.jira2md.outputs.output-text }}"
```
### Convert markdown -> Jira
```yml
- uses: peter-evans/jira2md@v2
id: md2jira
with:
input-text: |
**Some bold things**
*Some italic stuff*
## H2
mode: md2jira
- run: echo "${{ steps.md2jira.outputs.output-text }}"
```
### Action inputs
| Name | Description | Default |
| --- | --- | --- |
| `input-text` | The input text to convert. | |
| `mode` | The conversion mode; `jira2md`, `md2jira`, `md2html` or `jira2html`. | `jira2md` |
#### Outputs
- `output-text` - The converted text.
## License
[MIT](LICENSE)