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

docs: updates action.yml descriptions and README #9

Merged
merged 1 commit into from
Jun 27, 2023
Merged

docs: updates action.yml descriptions and README #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,9 @@ make test
### Run with poetry
```
poetry run trestle-bot
```
```

## Additional information on workflow inputs

- markdown_path: This is the location for Markdown generated by the `trestle author <model>-generate` commands
- ssp_index_path: This is a text file that stores the component definition information by name in trestle with the ssp name. Each line should look like ssp:mycomp
4 changes: 2 additions & 2 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ inputs:
required: false
default: ${{ github.head_ref }}
file_pattern:
description: File pattern used for `git add`. For example `src/*.js`
description: File pattern used for `git add`. For example `component-definitions/*`. Defaults to (`.`)
required: false
default: '.'
repository:
Expand All @@ -38,7 +38,7 @@ inputs:
required: false
default: 41898282+github-actions[bot]@users.noreply.github.com
commit_author_name:
description: Named used for the commit author. Defaults to the username of whoever triggered this workflow run.
description: Name used for the commit author. Defaults to the username of whoever triggered this workflow run.
required: false
default: ${{ github.actor }}
commit_author_email:
Expand Down