Table generator
This GitHub Action creates a html table in your README.md from a json file.
Inputs
github-token [REQUIRED]
This is available in your GitHub Action
with:
github-token: ${{ secrets.GITHUB_TOKEN }}html-cell [REQUIRED]
This is the html table cell content with object-field-names
with:
html-cell: '<td>{{ firstname }} {{ lastname }}</td>'object-field-names [REQUIRED]
This is json, and contains a list of the names of the fields in your json file data object
with:
object-field-names: '[ "firstname", "lastname" ]'columns [OPTIONAL]
defaults to 2
with:
columns: 3json-file-path [OPTIONAL]
defaults to data.json
with:
json-file-path: 'your-filename.json'file-to-use [OPTIONAL]
Defaults to README.md
with:
file-to-use: 'README.md'Example usage
Add <!--START_SECTION:data-section--> and <!--END_SECTION:data-section--> where you would like your table to appear in your README.
jobs:
table:
runs-on: ubuntu-latest
name: Update README from json data
steps:
- uses: actions/checkout@v2
- name: Read/Write data into README
uses: eddiejaoude/[email protected]
with:
json-file-path: 'data.json'
github-token: ${{ secrets.GITHUB_TOKEN }}
columns: 3
object-field-names: '[ "githubUsername", "name", "imageUrl", "issueNumber" ]'
file-to-use: 'README.md'
html-cell: '<td align="center"><p><a href="https://github.com/{{ githubUsername }}">{{ name }}</a></p><img src="{{ imageUrl }}" /><p><a href="https://github.com/EddieJaoudeCommunity/awesome-github-profiles/issues/{{ issueNumber }}">(:100: give your vote)</a></p></td>'Json file
[
{
"name": "Akas Rai",
"githubUsername": "akasrai",
"imageUrl": "https://user-images.githubusercontent.com/624760/88123456-d40df580-cbc2-11ea-9add-a7fc8675b243.png",
"issueNumber": 12
}
]From this repository usage https://github.com/EddieJaoudeCommunity/awesome-github-profiles