This orb has a collection of commands and jobs that IPA use to deploy their services.
Since 3.0.0 the deploy orb uses OIDC to exchange a JWT signed by CircleCI for temporary credentials. This requires that the AWS accounts have Identity Provider set up that trusts CircleCI (see this page or this page for details on how to do this.). This orb also requires you that store the arn of the role it will assume as CIRCLE_IAM_ROLE_ARN
in your context.
Note: If your context still has AWS credentials, then these will over-ride the temporary credentials. You should remove these when they are no longer required.
This command exports and allows the use of a "SLACK_DEPLOY_FAILED_TEMPLATE" env var as the template
parameter for the slack orb's notify
command.
This command can be used to set up a npm token stored under environment variable NPM_TOKEN
and then install npm dependencies.
Parameters:
service-account
- The service account email address to rotate the key ofsteps
- The series of steps to perform during key rotationssm-path
- The SSM path to save the updated key in
This command can be used to send a slack notification if a job fails
Parameters:
channel
- The slack chanel that a notification should be sent tomentions
- Any slack handles that should be mentioned in the noticiation
This command can be used to deploy a serverless stack and run integration tests on that stack.
Parameters:
executor
- The executor that the command should be ran onstage
- The stage that the integration stack is being deployed toregion
- The region that the integration stack is being deployed to
This job is used to checkout git and save to workspace.
This job is used to run eslint against the source code.
This job is used to run the tests saved in the repo.
This job deploys the serverless stack to an AWS account.
Parameters:
stage
- The stage that the serverless stack should be deployed withregion
- AWS region to deploy tobranch
- The git branch that the change was deployed from. Can be passed in using << pipeline.git.branch >>.
This job can be used to delete the feature stack deployed from a git branch after the branch has been merged in.
Parameters:
region
- AWS region that the stack is being removed from
This job can be used to delete the feature stack deployed from a git branch, for integration tests, after the branch has been merged in.
Parameters:
region
- AWS region that the stack is being removed from
- 3.0.0 - Switched to use OIDC
- 2.0.1 - Add npm ci step
- 2.0.0 - Removed serverless-plugin-aws-alerts