Skip to content

Commit

Permalink
Fix README Formatting (#1)
Browse files Browse the repository at this point in the history
Fix README formatting for GitHub Marketplace
  • Loading branch information
Alexander Praschek authored Apr 23, 2021
1 parent 2a7de8a commit 1a51a7b
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ this action. You can use the following options.
Option|Meaning
---|---
`gcp-project-id` | **Required.** The project ID to use for all GCP services.
`gcp-service-account-key` | **Required.** The content of the service account JSON file to use for<br>authentication.
`gcp-cloud-storage-bucket` | The Cloud Storage bucket to use to temporarily store the Cloud Build <br>input files. By default, the bucket `${projectId}_cloudbuild` will<br>be used. **You have to create this first manually.** The uploaded files<br>will be deleted after the build has finished.
`gcp-gcr-region` | The region to use for Google Container Registry. Can be one of the<br>following values:<ul><li>`gcr.io`</li><li>`eu.gcr.io`</li><li>`us.gcr.io`</li><li>`asia.gcr.io`</li></ul> The default value is `eu.gcr.io`.
`gcp-service-account-key` | **Required.** The content of the service account JSON file to <br> use for authentication.
`gcp-cloud-storage-bucket` | The Cloud Storage bucket to use to temporarily store the <br> Cloud Build input files. By default, a bucket with the name <br> `${projectId}_cloudbuild` will be used. The uploaded <br> files will be deleted after the build has finished. <br><br> **You have to create the specified bucket first manually.**
`gcp-gcr-region` | The region to use for Google Container Registry. Can be <br> one of the following values:<ul><li>`gcr.io`</li><li>`eu.gcr.io`</li><li>`us.gcr.io`</li><li>`asia.gcr.io`</li></ul> The default value is `eu.gcr.io`.

### Building the image

Expand All @@ -48,7 +48,7 @@ To build the image successfully, you have to specify at least these options.
Option|Meaning
---|---
`image-name` | **Required.** The name of the image to build.
`image-sources` | **Required.** The sources to use to build the image. <br><br>You can include any source files that are within your GitHub workspace, such as <br>build artifacts or Dockerfiles. The option also supports globstar wildcards such <br>as `?`, `*`, `**`, or `[...]`. See [this repository](https://github.com/actions/toolkit/tree/master/packages/glob) for more details.
`image-sources` | **Required.** The sources to use to build the image. <br><br> You can include any source files that are within your GitHub workspace, <br> such as build artifacts or Dockerfiles. The option also supports globstar <br> wildcards such as `?`, `*`, `**`, or `[...]`. Read [this](https://github.com/actions/toolkit/tree/master/packages/glob) for more details.

### Tagging the image

Expand All @@ -59,9 +59,9 @@ these options.
Option|Meaning
---|---
`image-tag-latest` | Set this to `true` to add the `latest` tag to the image.
`image-tag-branch-latest` | Set this to `true` to add the `${branch}-latest` tag to the image.
`image-tag-additional-tags` | Set this to a comma-separated list of values to specify additional tags.
`image-tag-format` | Specify the format of the default tag if it is caused by a commit.<br>You can use the following placeholders:<pre>$BRANCH The branch name, normalized.<br>$SHA The 7-digit SHA of the commit<br>$YYYY The year in 4-digit format<br>$MM The month in 2-digit format<br>$DD The day in 2-digit format<br>$HH The hour in 2-digit format (24h)<br>$mm The minute in 2-digit-format<br>$SS The second in 2-digit-format</pre>The default format is `$BRANCH-$SHA-$YYYY.$MM.$DD-$HH.$mm.$SS`.
`image-tag-branch-latest` | Set this to `true` to add the `${branch}-latest` tag to <br> the image.
`image-tag-additional-tags` | Set this to a comma-separated list of values to specify <br> additional tags.
`image-tag-format` | Specify the format of the default tag if it is caused by <br> a commit. You can use the following placeholders:<pre>$BRANCH The branch name, normalized.<br>$SHA The 7-digit SHA of the commit<br>$YYYY The year in 4-digit format<br>$MM The month in 2-digit format<br>$DD The day in 2-digit format<br>$HH The hour in 2-digit format (24h)<br>$mm The minute in 2-digit-format<br>$SS The second in 2-digit-format</pre> Default: `$BRANCH-$SHA-$YYYY.$MM.$DD-$HH.$mm.$SS`.

### GitHub Integration

Expand All @@ -70,7 +70,7 @@ tag), there are different ways to achieve this. **You have to specify one of the

Option|Meaning
---|---
`github-token` | The token to use to authenticate to GitHub. Usually the [default token provided <br>by GitHub Actions](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) is sufficient. You can specify it like this:<pre>github-token: ${{ secrets.GITHUB_TOKEN }}</pre>
`github-token` | The token to use to authenticate to GitHub. Usually the [default token <br> provided by GitHub Actions](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) is sufficient. <br><br> You can specify it like this: <pre>github-token: ${{ secrets.GITHUB_TOKEN }}</pre>
`github-disabled` | Disables all GitHub integrations.

### GitHub Commit Status
Expand All @@ -87,9 +87,9 @@ You can configure this by specifying one or several of the following options:
Option|Meaning
---|---
`github-commit-status-disabled` | Set this to `true` to disable this integration.
`github-commit-status-all` | Set this to `true` to add every tag in a separate row. By default, only<br>the primary tag will be added.
`github-commit-status-description` | This option specifies the format in which the tags will be displayed.<br>The default value is `small`. Can be one of the following values:<br><pre>large host/project/image:tag<br> <b>-> eu.gcr.io/flowsquad-io/test-image:latest</b><br><br>medium project/image:tag<br> <b>-> flowsquad-io/test-image:latest</b><br><br>small image:tag<br> <b>-> test-image:latest</b><br><br>tiny tag<br> <b>-> latest</b></pre>
`github-commit-status-title` | This option specifies the title used in the commit status. The<br>default value is `Docker Image`.
`github-commit-status-all` | Set this to `true` to add every tag in a separate <br> row. By default, only the primary tag will be added.
`github-commit-status-description` | This option specifies the format in which the tags <br> will be displayed. The default value is `small`. <br> Can be one of the following values: <pre>large host/project/image:tag<br><b>eu.gcr.io/flowsquad-io/my-image:latest</b><br><br>medium project/image:tag<br><b>flowsquad-io/my-image:latest</b><br><br>small image:tag<br><b>my-image:latest</b><br><br>tiny tag<br><b>latest</b></pre>
`github-commit-status-title` | This option specifies the title used in the commit <br> status. The default value is `Docker Image`.

### GitHub Release information

Expand All @@ -105,7 +105,7 @@ You can configure this by specifying one or several of the following options:
Option|Meaning
---|---
`github-release-information-disabled` | Set this to `true` to disable this integration.
`github-release-information-all` | Set this to `true` to add all image tags instead of just <br>the primary one.
`github-release-information-all` | Set this to `true` to add all image tags instead <br> of just the primary one.

## Example

Expand Down

0 comments on commit 1a51a7b

Please sign in to comment.