Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/austenstone/job-summary
Get and convert job summaries to Md, PDF, and HTML
https://github.com/austenstone/job-summary
actions github-actions job-summaries pdf pdf-converter
Last synced: 19 days ago
JSON representation
Get and convert job summaries to Md, PDF, and HTML
- Host: GitHub
- URL: https://github.com/austenstone/job-summary
- Owner: austenstone
- License: mit
- Created: 2024-04-25T03:17:28.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T14:04:57.000Z (3 months ago)
- Last Synced: 2024-10-10T21:17:20.659Z (about 1 month ago)
- Topics: actions, github-actions, job-summaries, pdf, pdf-converter
- Language: TypeScript
- Homepage:
- Size: 15.3 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Job Summary Action
Get and convert job summaries to Md, PDF, and HTML.
> [!TIP]
> Try combining this with notification actions such as [send-email](https://github.com/marketplace/actions/send-email), [slack](https://github.com/marketplace/actions/slack-send), [teams](https://github.com/marketplace/actions/microsoft-teams-notification), [discord](https://github.com/marketplace/actions/discord-message-notify), etc.
#### Usage
Call the action and it will save the job summary as a PDF called job-summary.pdf
```yml
- uses: austenstone/[email protected]
```
#### Usage to get only markdown summary
```yml
- uses: austenstone/[email protected]
id: job-summary
with:
create-pdf: false
- run: echo "${{ steps.job-summary.outputs.job-summary }}"
```
## ➡️ Inputs
Various inputs are defined in [`action.yml`](action.yml):
| Name | Description | Default | Required |
| --- | - | - | - |
| name | The name of the Md and PDF file. | README | false |
| create-pdf | Whether to create a PDF file. | true | false |
| create-pdf-artifact | If the PDF will be saved as an artifact. | true | false |
| create-md | Whether to create a markdown file. | true | false |
| create-md-artifact | If the markdown will be saved as an artifact. | true | false |
## ⬅️ Outputs
| Name | Description |
| --- | - |
| job-summary | The full job summary as markdown. |
| pdf-file | The path to the PDF file. |
| md-file | The path to the markdown file. |
## Further help
To get more help on the Actions see [documentation](https://docs.github.com/en/actions).