auto

GitHub actions that enable an automated CI/CD pipeline

Actions

Build-Test-Deploy

Build docker images, run the testing harness, push to GitHub Package Repository and Heroku Container Registry, and deploy the image to a target Heroku app

inputs:
  image_tag: 
    description: 'Tag of the github package repo image'
    required: true
  app_name:
    description: 'Target Heroku app name'
    required: true
  github_token:
    description: 'Token for github package repo'
    required: true

In addition to defining all the inputs in the with section of the target workflow, you must set the HEROKU_API_KEY in the env section.

This action uses docker with an entrypoint script. The base image is in the directory as Dockerfile.build. It is currently being hosted on DockerHub because GitHub Package Repository does not allow for non-auth public pulls

Review

Create and delete Heroku apps in a target pipeline

inputs:
  base:
    description: 'The base name of the app'
    required: true
  pipeline: 
    description: 'A heroku pipline id to add the new app to'
    required: true
  stage:
    description: 'A stage to add the app to'
    required: false
    default: 'development'
  token:
    description: 'API token of the heroku account'
    required: true
outputs:
  app_name: 
    description: 'The name of the app that is created'
  database_url:
    description: 'The postgresql url of the provisioned db'

Tag

Automatically tags on pull requests into master

inputs:
  repo_token:
    required: true
    description: 'The GITHUB_TOKEN secret'

Contributing

Dependencies

All dependencies are managed in a central package.json. Each action will be bundled individually and only include what they use

Scripts

yarn test

Runs on all PR to develop and master

Test all actions that have a test.js

yarn build

Runs on all pushes to master

Uses ncc to compile each javascript based action into its own build/index.js file

Create an Action

Official actions documentation

1. Create a new folder <your action name> in the project root
2. Create action.yml, handler.js, and test.js files in your new folder
3. Setup the action to run build/index.js and fill out the other relevant fields in action.yml

# auto/<your action name>/action.yml
name: ''
description: ''
inputs:
  input_name:
    description: ''
    required: true
outputs:
  output_name: 
    description: ''
runs:
  using: 'node12'
  main: 'build/index.js'

4. Create functionality in handler.js and write some tests in test.js
5. Merge your branch into master
6. Create a new release with an incremental minor version
7. Use your action in a workflow

- name: Use your action
  uses: STEM-C/auto/<your action name>@vX.X