https://github.com/raulanatol/template-action-docker
📓 A simple docker container action template
https://github.com/raulanatol/template-action-docker
actions boilerplate docker template
Last synced: 2 months ago
JSON representation
📓 A simple docker container action template
- Host: GitHub
- URL: https://github.com/raulanatol/template-action-docker
- Owner: raulanatol
- License: mit
- Created: 2020-08-30T16:51:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-30T17:37:47.000Z (almost 6 years ago)
- Last Synced: 2025-03-16T01:15:04.409Z (over 1 year ago)
- Topics: actions, boilerplate, docker, template
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
template-action-docker
📓 A simple docker container action template
---
## Table of Contents
- [Inputs](#inputs)
- [`who-to-greet`](#who-to-greet)
- [Outputs](#outputs)
- [`time`](#time)
- [Example usage](#example-usage)
- [Example using a public action](#example-using-a-public-action)
- [Example using a private action](#example-using-a-private-action)
- [Development](#development)
- [Close release](#close-release)
- [Documentation](#documentation)
## Inputs
### `who-to-greet`
**Required** The name of the person to greet. Default `"World"`.
## Outputs
### `time`
The time we greeted you.
## Example usage
```yaml
uses: raulanatol/template-action-docker@v1.0.0
with:
who-to-greet: 'Mona the Octocat'
```
## Example using a public action
**.github/workflows/main.yml**
```yaml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: A job to say hello
steps:
- name: Hello world action step
id: hello
uses: raulanatol/template-action-docker@v1.0.0
with:
who-to-greet: 'Mona the Octocat'
# Use the output from the `hello` step
- name: Get the output time
run: echo "The time was ${{ steps.hello.outputs.time }}"
```
## Example using a private action
**.github/workflows/main.yml**
```yaml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: A job to say hello
steps:
# To use this repository's private action,
# you must check out the repository
- name: Checkout
uses: actions/checkout@v2
- name: Hello world action step
uses: ./ # Uses an action in the root directory
id: hello
with:
who-to-greet: 'Mona the Octocat'
# Use the output from the `hello` step
- name: Get the output time
run: echo "The time was ${{ steps.hello.outputs.time }}"
```
## Development
### Close release
To close a release you only need to execute the makefile with `release_{major|minor|patch}`
Example:
```shell script
make release_minor
```
### Documentation
To generate the documentation you only need to execute the makefile with `docs`.
> Using [doctoc](https://github.com/thlorenz/doctoc)
```shell script
make docs
```