Skip to content

Commit eb4f228

Browse files
Update README.md and docs (#7)
Co-authored-by: goruha <[email protected]>
1 parent 5843d3f commit eb4f228

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,27 @@ Feel free to use it as reference and starting point.
9696
9797
9898
<!-- markdownlint-disable -->
99+
99100
## Inputs
100101
101102
| Name | Description | Default | Required |
102103
|------|-------------|---------|----------|
103-
| param1 | Input parameter placeholder | true | true |
104+
| from | Source tag | N/A | false |
105+
| login | Docker login | | false |
106+
| organization | Organization | N/A | true |
107+
| password | Docker password | | false |
108+
| registry | Docker registry | N/A | true |
109+
| repository | Repository | N/A | true |
110+
| to | Target tags | N/A | false |
111+
| use\_metadata | Extract target tags from Git reference and GitHub events | true | false |
112+
104113
105114
## Outputs
106115
107116
| Name | Description |
108117
|------|-------------|
109-
| result1 | Output result placeholder |
118+
| image | Docker image name |
119+
| tag | Docker image tag |
110120
<!-- markdownlint-restore -->
111121
112122

docs/github-action.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44

55
| Name | Description | Default | Required |
66
|------|-------------|---------|----------|
7-
| param1 | Input parameter placeholder | true | true |
7+
| from | Source tag | N/A | false |
8+
| login | Docker login | | false |
9+
| organization | Organization | N/A | true |
10+
| password | Docker password | | false |
11+
| registry | Docker registry | N/A | true |
12+
| repository | Repository | N/A | true |
13+
| to | Target tags | N/A | false |
14+
| use\_metadata | Extract target tags from Git reference and GitHub events | true | false |
815

916

1017
## Outputs
1118

1219
| Name | Description |
1320
|------|-------------|
14-
| result1 | Output result placeholder |
21+
| image | Docker image name |
22+
| tag | Docker image tag |
1523
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)