Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/petems/csv-to-md-table-action
A Github action to convert CSV to markdown
https://github.com/petems/csv-to-md-table-action
csv github-actions markdown markdown-to-csv
Last synced: 19 days ago
JSON representation
A Github action to convert CSV to markdown
- Host: GitHub
- URL: https://github.com/petems/csv-to-md-table-action
- Owner: petems
- License: mit
- Created: 2020-09-19T18:06:32.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T09:10:54.000Z (7 months ago)
- Last Synced: 2024-10-26T20:17:32.263Z (25 days ago)
- Topics: csv, github-actions, markdown, markdown-to-csv
- Language: JavaScript
- Homepage:
- Size: 1.28 MB
- Stars: 11
- Watchers: 3
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# csv-to-md-table-action
This action prints converts a given CSV to a markdown formatted table
## Inputs
### `csvinput`
**Required** CSV to be converted.
## Outputs
### `markdown-table`
The markdown formatted table
## Example usage
```yaml
uses: petems/csv-to-md-table-action@master
with:
csvinput: |
First Name, Last Name, Address, Town, State, Zip
John,Doe,120 jefferson st.,Riverside, NJ, 08075
Jack,McGinnis,220 hobo Av.,Phila, PA,09119
```
You can then take the output to post comments on pull-requests for example:
```yaml
on:
pull_request:
paths:
- '*/**.csv'
jobs:
build:
name: Comment CSV as Pull-request Table
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@master
- name: Read CSV
id: csv
uses: juliangruber/read-file-action@v1
with:
path: ./people.csv
- name: Create MD
uses: petems/csv-to-md-table-action@master
id: csv-table-output
with:
csvinput: ${{ steps.csv.outputs.content }}
- uses: mshick/add-pr-comment@v1
with:
message: |
${{steps.csv-table-output.outputs.markdown-table}}
repo-token: ${{ secrets.GITHUB_TOKEN }}
repo-token-user-login: 'github-actions[bot]' # The user.login for temporary GitHub tokens
allow-repeats: true
```
So when you make a change to CSV file via pull-request, it makes a comment with the table:
There's a demo of it in action here: https://github.com/petems/csv-table-comment-example
## Testing
Install the dependencies
```bash
npm install
```
Run the tests :heavy_check_mark:
```bash
$ npm test
> [email protected] test /Users/petersouter/projects/csv-to-md-table-action
> jest
PASS ./index.test.js
✓ parses csv and converts to valid markdown table (138ms)
...
```
## Package for distribution
GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.
Run prepare
```bash
npm run prepare
```
Since the packaged index.js is run from the dist folder.
```bash
git add dist
```
## Create a release branch
Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
Checkin to the v1 release branch
```bash
git checkout -b v1
git commit -a -m "v1 release"
```
```bash
git push origin v1
```
Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
Your action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)