Skip to content

Commit

Permalink
Update README.md and docs (#7)
Browse files Browse the repository at this point in the history
Co-authored-by: goruha <[email protected]>
  • Loading branch information
cloudpossebot and goruha authored Nov 16, 2022
1 parent 5843d3f commit eb4f228
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,27 @@ Feel free to use it as reference and starting point.
<!-- markdownlint-disable -->
## Inputs
| Name | Description | Default | Required |
|------|-------------|---------|----------|
| param1 | Input parameter placeholder | true | true |
| from | Source tag | N/A | false |
| login | Docker login | | false |
| organization | Organization | N/A | true |
| password | Docker password | | false |
| registry | Docker registry | N/A | true |
| repository | Repository | N/A | true |
| to | Target tags | N/A | false |
| use\_metadata | Extract target tags from Git reference and GitHub events | true | false |
## Outputs
| Name | Description |
|------|-------------|
| result1 | Output result placeholder |
| image | Docker image name |
| tag | Docker image tag |
<!-- markdownlint-restore -->
Expand Down
12 changes: 10 additions & 2 deletions docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,20 @@

| Name | Description | Default | Required |
|------|-------------|---------|----------|
| param1 | Input parameter placeholder | true | true |
| from | Source tag | N/A | false |
| login | Docker login | | false |
| organization | Organization | N/A | true |
| password | Docker password | | false |
| registry | Docker registry | N/A | true |
| repository | Repository | N/A | true |
| to | Target tags | N/A | false |
| use\_metadata | Extract target tags from Git reference and GitHub events | true | false |


## Outputs

| Name | Description |
|------|-------------|
| result1 | Output result placeholder |
| image | Docker image name |
| tag | Docker image tag |
<!-- markdownlint-restore -->

0 comments on commit eb4f228

Please sign in to comment.