Skip to content
This repository was archived by the owner on Aug 30, 2021. It is now read-only.

Commit bdfe79b

Browse files
committed
Include README and adjust action metadata
Action needed to be renamed before publishing to GitHub Marketplace, and a README needed to be written. The README contains all available inputs and outputs, as well as an example on how to use the action. README.md | 41 +++++++++++++++++++++++++++++++++++++++++ action.yml | 5 ++++- 2 files changed, 45 insertions(+), 1 deletion(-)
1 parent ee982af commit bdfe79b

2 files changed

Lines changed: 45 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# GitHub Docker Action
2+
3+
Build and publish your repository as a Docker image and push it to GitHub Package Registry in one easy step.
4+
5+
## Inputs
6+
7+
### `username`
8+
9+
**Required**. GitHub user to publish the image on behalf of.
10+
11+
### `personalAccessToken`
12+
13+
**Required**. GitHub Personal Access Token for the user. Must have write permissions for packages.
14+
15+
### `repositoryName`
16+
17+
Optional. The repository to push the image to. Defaults to current repository. Must be specified in format `user/repo`.
18+
19+
### `imageName`
20+
21+
Optional. The desired name for the image. Defaults to current repository name.
22+
23+
### `imageTag`
24+
25+
Optional. The desired tag for the image. Defaults to current branch or release version number.
26+
27+
## Outputs
28+
29+
### `imageURL`
30+
31+
The full URL of the image.
32+
33+
## Example usage
34+
35+
```yaml
36+
- name: Publish Image
37+
uses: matootie/github-docker@v1.0.0
38+
with:
39+
username: matootie
40+
personalAccessToken: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
41+
```

action.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'GitHub Docker'
1+
name: 'GitHub Docker Action'
22
description: 'Build and publish your repository as a Docker image and push it to GitHub Package Registry in one step'
33
inputs:
44
username:
@@ -22,3 +22,6 @@ outputs:
2222
runs:
2323
using: 'node12'
2424
main: 'dist/index.js'
25+
branding:
26+
icon: 'anchor'
27+
color: 'blue'

0 commit comments

Comments
 (0)