https://github.com/aligent/nx-serverless-deploy-pipe
https://github.com/aligent/nx-serverless-deploy-pipe
pipe serverless
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aligent/nx-serverless-deploy-pipe
- Owner: aligent
- License: gpl-3.0
- Created: 2023-09-14T23:55:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T01:35:27.000Z (12 months ago)
- Last Synced: 2025-06-22T05:11:56.928Z (10 months ago)
- Topics: pipe, serverless
- Language: TypeScript
- Homepage:
- Size: 96.7 KB
- Stars: 0
- Watchers: 13
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Aligent Serverless Deploy Pipe
This pipe is used to deploy:
- Multiple Serverless Framework applications in an Nx monorepo.
- Single Serverless Framework application in a polyrepo.
## YAML Definition
Add the following your `bitbucket-pipelines.yml` file:
> Please note: there is currently an issue when used with Bitbucket's node cache type. This cannot be used in the step until resolved.
```yaml
- step:
name: 'deploy service'
script:
- pipe: docker://aligent/nx-serverless-deploy-pipe:latest
variables:
AWS_ACCESS_KEY_ID: ${AWS_ACCESS_KEY_ID}
AWS_SECRET_ACCESS_KEY: ${AWS_SECRET_ACCESS_KEY}
```
## Variables
| Variable | Usage |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| AWS_ACCESS_KEY_ID | (Required) Injects AWS Access key |
| AWS_SECRET_ACCESS_KEY | (Required) Injects AWS Secret key |
| CFN_ROLE | [CloudFormation service role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html) to use for deployment |
| STAGE | Define the stage to deploy. Must be exact three characters. (Default: `stg`) |
| DEBUG | Turn on extra debug information. (Accepted values: `true`/`false`) |
| UPLOAD_BADGE | Whether or not to upload a deployment badge to the repositories downloads section. (Accepted values: `true`/`false`) |
| APP_USERNAME | The user to upload the badge as. Required if UPLOAD_BADGE is set to `true`. |
| APP_PASSWORD | The app password of the user uploading the badge. Required if UPLOAD_BADGE is set to `true`. |
| TIMEZONE | Which time zone the time in the badge should use (Default: `Australia/Adelaide`) |
| PROFILE | The profile name that is used for deployment (Default: `bitbucket-deployer`) |
| CMD | The command that this pipe will run (Eg: `deploy`, `remove`. Default: `deploy`) |
| SERVICES_PATH | The relative path from root folder to the folder where applications are defined (Default: `services`) |
- Default pipelines variables that are available for builds: https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
- Please check: https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/ for how to generate an app password.
## Monorepo structure
The pipe expects:
1. A single `nx.json` file at the root folder.
2. Each application to be under a folder as defined via `SERVICES_PATH` variable above (default as `services`), and to have a `serverless.yml` and a `project.json` files in its own folder.
```
.
├── nx.json
├── services/
│ ├── application-one/
│ │ ├── serverless.yml
│ │ ├── project.json
│ │ └── ...other files
│ └── application-two/
│ ├── serverless.yml
│ ├── project.json
│ └── ...other files
└── ...other files
```
The `project.json` file defining an Nx target called `deploy`, which implements serverless deployment command:
```json
{
"targets": {
"deploy": {
"executor": "nx:run-commands",
"options": {
"cwd": "services/application-one",
"color": true,
"command": "sls deploy"
}
}
// ... other targets
}
// ... other nx configuration
}
```
## Polyrepo structure
The pipe expects:
1. No `nx.json` file at the root folder.
2. A `serverless.yml` file at the root folder.
```
.
├── serverless.yml
├── src/
│ └── ...other files
└── ...other files
```
## Development
1. build the image locally:
```bash
# Transpile our source code to Javascript
npm run build
# [Optional] Run this if we want to remove devDependencies from node_modules before building docker image
# If we run this, we will need to re-run `npm ci` later on if we fix bug & want to build another image.
npm prune --production
# Build docker image
docker build --build-arg="NODE_TAG=20" -t aligent/nx-pipe:20-alpine .
```
2. Run the container locally and mount current local directory to the /app/work folder:
```bash
docker run -it --memory=4g --memory-swap=4g --memory-swappiness=0 --cpus=4 --entrypoint=/bin/sh \
-v $(pwd):/app/work --workdir=/app/work \
-e BITBUCKET_CLONE_DIR=/app/work \
-e PROFILE=bitbucket-deployer \
-e STAGE=stg \
-e AWS_ACCESS_KEY_ID=test-access-key-id \
-e AWS_SECRET_ACCESS_KEY=test-secret-access-key \
-e CFN_ROLE=test-cfn-role \
-e UPLOAD_BADGE=false \
-e APP_USERNAME=test-app-username \
-e APP_PASSWORD=test-app-password \
-e DEBUG=true \
aligent/nx-pipe:20-alpine
```
## See also
https://nx.dev/ \
https://www.serverless.com/framework/docs/providers/aws/guide/deploying \
https://www.serverless.com/framework/docs/providers/aws/cli-reference/config-credentials