Aligent GitHub Workflows

A collection of GitHub action workflows. Built using the reusable workflows guide from GitHub.

Workflows

Node Pull Request Checks

Inputs

Name	Required	Type	Default	Description
package-manager	❌	string	yarn	Node package manager to use
is-yarn-classic	❌	boolean	false	When package-manager is yarn, this can be used to indicate that the project uses a pre-Berry version of Yarn, which changes what flags we can pass to the command
skip-cache	❌	boolean	false	When package-manager is yarn, this can be used to indicate that we should use the --force flag to tell Yarn to ignore cache and fetch dependencies from the package repository
build-command	❌	string	build	Command to override the build command
test-command	❌	string	test	Command to override the test command
lint-command	❌	string	lint	Command to override the lint command
format-command	❌	string	format	Command to override the format command
skip-build	❌	boolean	false	If the build step should be skipped
skip-test	❌	boolean	false	If the test step should be skipped
skip-lint	❌	boolean	false	If the lint step should be skipped
skip-format	❌	boolean	false	If the format step should be skipped
debug	❌	boolean	false	If debug flags should be set

Example Usage

jobs:
  test-s3-deploy:
    uses: aligent/workflows/.github/workflows/node-pr.yml@main
    with:
      skip-format: false

S3 Deployment

Inputs

Name	Required	Type	Default	Description
aws-region	❌	string	ap-southeast-2	AWS region
s3-bucket	✅	string		Name of the S3 bucket
s3-path	❌	string		Path in the S3 bucket
local-path	✅	string		Path to deploy
delete-flag	❌	boolean	true	Enable --delete flag
cache-control	❌	string		Cache control headers
extra-args	❌	string		Additional AWS CLI args

Secrets

Name	Required	Description
aws-access-key-id	✅	AWS Access Key ID
aws-secret-access-key	✅	AWS Secret Access Key

Example Usage

jobs:
  deploy-to-s3:
    uses: aligent/workflows/.github/workflows/s3-deploy.yml@main
    with:
      s3-bucket: my-bucket
      local-path: ./dist
      s3-path: /public
      cache-control: "max-age=3600"
    secrets:
      aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
      aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

Nx Serverless Deployment

Inputs

Name	Required	Type	Default	Description
aws-access-key-id	✅	string		AWS Access Key
aws-secret-access-key	✅	string		AWS Secret Access Key
cfn-role	✅	string		AWS CFN Role to assume
aws-profile	✅	string		AWS Profile
aws-region	❌	string	ap-southeast-2	AWS Region to deploy to
stage	✅	string		Stage to deploy to
environment	✅	string		The GitHub environment to run in
command	❌	string	build	Command to run during the deploy step
package-manager	❌	string	yarn	Node package manager to use
build-command	❌	string	build	Command to override the build command
debug	❌	boolean	false	If verbose logging should be enabled

Example Usage

jobs:
  deploy-serverless:
    uses: aligent/workflows/.github/workflows/nx-serverless-deployment.yml@main
    with:
      aws-profile: my-profile
      stage: dev
      environment: development
      debug: true
    secrets:
      aws-access-key-id: '123'
      aws-secret-access-key: '456'