aplaceformom / workflows

Reusable workflows

A Place For Mom Re-usable Workflows

These workflows are re-usable and can be used following the documentation found here.

Workflows

• apollo-check.md
• default-config.md
• docker-build.md
• docker-win-build.md
• ecs-deploy.md
• git-commit-message.md
• github-event.md
• lambda-deploy.md
• mongo-check.md
• nodejs-check.md
• nodejs-run.md
• pre-commit.md
• sentry-release.md

Integrations

Similarly you can find documentation about the integrations, in the .github/scripts directory.

Contributing

1. clone the repo
2. run pre-commit install inside the repository root
3. do other stuff

workflows's Issues

get initial workflows setup

Improve reusable workflow documentation.

We should enhance our reusable-workflow documentation such that we can have a pre-existing document which includes a description, explanations, and examples, and the params automatically generated w/in the document. This would follow the model set down by terraform-docs, making it the path of least surprise as well as making the system more flexible. Further more, this allows us to add special documentation to workflows such as the deployment workflow which can link out to the techops-infrastructure repository docs for editing/modifying the alb-ecs-service variables per environment.

Total target behavior:

• config which specifies the being/end keys for automatic insertion of the param docs (with sane defaults).
• config which specifies the path to the per-workflow docs (default to ${git_topdir}/docs).
• enable/disable adding a TOC for all docs to the top-level README.md (default enabled). TOC should also obey a begin/end pattern so we can have a good default description of the project in the top of the README.md