Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update the default col_max_words #393

Merged
merged 8 commits into from Dec 30, 2022
Merged

chore: update the default col_max_words #393

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c5f19f1
chore: update the default col_max_words
jackton1 Dec 30, 2022
cdae5c0
Merge c5f19f1bc0f9d347ee9eac3aa9537a6bda87a1b8 into c17c3df854d69a481…
jackton1 Dec 30, 2022
e627070
Updated README.
github-actions[bot] Dec 30, 2022
d0a2882
Merge branch 'main' into chore/update-the-default-col_max_words
jackton1 Dec 30, 2022
9d08f1e
Merge d0a2882e1dd649d75dac99a001e2380807869d00 into cb497147249dbf049…
jackton1 Dec 30, 2022
c40c1af
chore: Updated coverage badge.
actions-user Dec 30, 2022
b4a5446
Merge c40c1afab371304a9cd7d87f4c7a89710c25a9b4 into cb497147249dbf049…
jackton1 Dec 30, 2022
1cea1a8
Updated README.
github-actions[bot] Dec 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
@@ -1,5 +1,5 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/bb5dc10c1d2645c0894fa6774300639b)](https://app.codacy.com/gh/tj-actions/auto-doc?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/auto-doc\&utm_campaign=Badge_Grade_Settings)
![Coverage](https://img.shields.io/badge/Coverage-81.2%25-brightgreen)
![Coverage](https://img.shields.io/badge/Coverage-82.4%25-brightgreen)
[![Go Reference](https://pkg.go.dev/badge/github.com/tj-actions/auto-doc.svg)](https://pkg.go.dev/github.com/tj-actions/auto-doc)
[![Go Report Card](https://goreportcard.com/badge/github.com/tj-actions/auto-doc)](https://goreportcard.com/report/github.com/tj-actions/auto-doc)
[![CI](https://github.com/tj-actions/auto-doc/workflows/CI/badge.svg)](https://github.com/tj-actions/auto-doc/actions?query=workflow%3ACI)
Expand Down Expand Up @@ -42,15 +42,15 @@ Add the `Inputs` and/or `Outputs` [`H2` header](https://github.com/adam-p/markdo

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|----------------|--------|----------|----------------|------------------------------------------------------------------------------|
| action | string | false | `"action.yml"` | Path to the action.yml file<br> |
| bin\_path | string | false | | Path to the auto-doc binary<br> |
| col\_max\_width | string | false | `"1000"` | Max width of a column<br> |
| col\_max\_words | string | false | `"6"` | Max number of words per<br>line in a column |
| input\_columns | string | false | | List of Input columns names<br> to display, default (display all<br>columns) |
| output | string | false | `"README.md"` | Path to the output file<br> |
| output\_columns | string | false | | List of Output column names<br> to display, default (display all<br>columns) |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|----------------|--------|----------|----------------|--------------------------------------------------------------------------|
| action | string | false | `"action.yml"` | Path to the action.yml file |
| bin\_path | string | false | | Path to the auto-doc binary |
| col\_max\_width | string | false | `"1000"` | Max width of a column |
| col\_max\_words | string | false | `"5"` | Max number of words per line<br>in a column |
| input\_columns | string | false | | List of Input columns names to<br>display, default (display all columns) |
| output | string | false | `"README.md"` | Path to the output file |
| output\_columns | string | false | | List of Output column names to<br>display, default (display all columns) |

<!-- AUTO-DOC-INPUT:END -->

Expand Down