Shared actions, used over many different Assembly Line projets.
You can use the actions in repo github workflows by refering the subfolder of the desired action and the a specific branch or tagged version you want to run:
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/pythontests@main For assembly line projects, you should refer to the main branch, as that will allow
bug fixes to the actions to immediately propagate to the AssemblyLine repos.
pythontest sets up a python environment around the package, and runs any unittest tests in the package.
jobs:
my-workflow:
...
# No inputs
steps:
- uses: SuffolkLITLab/ALActions/pythontests@main jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/black-formatting@main
with:
MAKE_PR: "true"
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}black will also read configs from pyproject.toml. In most projects, we include the following:
[tool.black]
extend-exclude = '(__init__.py|setup.py)'docsig checks all of the docstrings in the python package to ensure that they match the function signature and have consistent styles.
Since we use Google style for our docstrings, the packages should use that, even though docsig allows NumPy and sphinx styles as well.
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/docsig@maindocsig can be configured by using pyproject.toml. See the docsig README.md for more info.
publish publishes a python package to pypi, and announces the publishing to a given Teams chat.
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/publish@main
with:
PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
VERSION_TO_PUBLISH: ${{ env.GITHUB_REF_NAME }}
TEAMS_BUMP_WEBHOOK: ${{ secrets.TEAMS_BUMP_WEBHOOK }}hall_monitor checks a given docassemble server to make sure that all of the installed interviews can load their first page correctly,
acting like a hall monitor peaking through doors, but not investigating any further.
You will likely want to run this action on a schedule, several times a day. You can see more about how to define this schedule in the github on.schedule documentation.
on:
schedule:
# Runs at 6:00am, and 18:00 (6:00pm)
- cron: "0 6,18 * * *"
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/hall_monitor@main
with:
SERVER_URL: "https://my-docassemble.example.com"This also supports sending email notifications (separate from GitHub's notification system, which doesn't let you notify arbitrary people about an action failing) to multiple, comma separated emails, using Sendgrid and Mailgun.
Here's a code example for sendgrid:
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/hall_monitor@main
with:
SERVER_URL: "https://my-docassemble.example.com"
SENDGRID_API_KEY: ${{ secrets.MY_SENDGRID_API_KEY }}
ERROR_FROM_EMAIL: Monitor <[email protected]>
ERROR_EMAILS: [email protected],[email protected]And one for Mailgun
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/hall_monitor@main
with:
SERVER_URL: "https://my-docassemble.example.com"
MAILGUN_API_KEY: ${{ secrets.MY_MAILGUN_API_KEY }}
MAILGUN_DOMAIN: ${{ secrets.MY_MAILGUN_DOMAIN }}
ERROR_FROM_EMAIL: Monitor <[email protected]>
ERROR_EMAILS: [email protected],[email protected]Word-diff creates a report of the changes to any .docx files between main and the current
pull request, after converting the files to markdown
on:
pull_request:
paths:
- '**/*.docx'
jobs:
my-workflow:
...
steps:
- uses: SuffolkLITLab/ALActions/word_diff@mainUsing codeql-action as a template for this repo.
This repo is mostly composite actions, as opposed to javascript or docker actions. Visit Github's documentation on composite actions for more info.