Actions Demo Project

[nmarchio]

To dos

Parameterization @AnGWar26

• Parameterize hard coded fields (i.e., Docker user credentials)
• Parameterize the CPU and memory in the call to the script to AWS

Documentation + YAML @AnGWar26

• Build documentation (describe parameters, arguments, what each job does, set up –stuff that happens outside the code clicking menus)
• Documentation on credentials needed for Secrets (AWS credentials, Google Sheets credentials,
• Add comments to the YAML template
• In YAML check if “needs” runs “on-success” or simply indicates job is completed

Job Scheduling @AnGWar26

• Add Job scheduling in GitHub Actions (regular interval)
  https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule

Notifications @manmartgarc

• Add email notification (when it starts, ends, and success / failure)
  AWS: https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html
  GitHub Actions: notifications for the entire workflow (when starts or if ended successfully / failure, possibly pass in logging)

S3 Bucket @manmartgarc

• Right now we assume a bucket is created and we get it through the GUI. Add a feature that passes in the bucket parameter if bucket doesn't exist then it creates the bucket.

R Job @manmartgarc or @AnGWar26

• Create an R environment in one job and run that in parallel (run on GitHub default machines alongside compute).
  https://github.com/r-lib/actions
• Create an R environment on AWS include that example as well

ECR @manmartgarc

• Example using the Elastic Container Registry (instead of Docker Hub). Include documentation for how to add the image to ECR.

[AnGWar26]

needs runs on success. There are ways to make it always run, but we aren't using them.

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds

[AnGWar26]

Completed:

• Parameterization
• Documentation + YAML
  • Needs some additions still but a lot of the work of getting together docs for AWS is done.
• Job Scheduling
• S3 Bucket creation if it doesn't already exist.

TODO at this point is just an R job environment, some sort of notifications for the job, and figuring out how to use ECR rather than DockerHub.

Will continue to aggregate and refine documentation as time goes on.

[AnGWar26]

To enable notifications for Github Actions Workflows go to:

https://github.com/settings/notifications

To see details about who will recieve notifications about the workflow runs:

https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs

[AnGWar26]

R environment and small sample job proof of concept completed as of 7225148.

[AnGWar26]

Push to ECR complete as of 7cdb537