README.md

Python Container Action Template

This is a template for creating GitHub actions and contains a small Python application which will be built into a minimal Container Action. Our final container from this template is ~50MB, yours may be a little bigger once you add some code. If you want something smaller check out my go-container-action template.

In main.py you will find a small example of accessing Action inputs and returning Action outputs. For more information on communicating with the workflow see the development tools for GitHub Actions.

🏁 To get started, click the Use this template button on this repository which will create a new repository based on this template.

Usage

Describe how to use your action here.

Example workflow

name: My Workflow
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Run action

      # Put your action repo here
      uses: me/myaction@master

      # Put an example of your mandatory inputs here
      with:
        myInput: world

Inputs

Input	Description
myInput	An example mandatory input
anotherInput (optional)	An example optional input

Outputs

Output	Description
myOutput	An example output (returns 'Hello world')

Examples

NOTE: People ❤️ cut and paste examples. Be generous with them!

Using the optional input

This is how to use the optional input.

with:
  myInput: world
  anotherInput: optional

Using outputs

Show people how to use your outputs in another action.

steps:
- uses: actions/checkout@master
- name: Run action
  id: myaction

  # Put your action name here
  uses: me/myaction@master

  # Put an example of your mandatory arguments here
  with:
    myInput: world

# Put an example of using your outputs here
- name: Check outputs
    run: |
    echo "Outputs - ${{ steps.myaction.outputs.myOutput }}"