https://github.com/architect/deploy
Deployment module for shipping @architect projects to the cloud
https://github.com/architect/deploy
Last synced: about 1 year ago
JSON representation
Deployment module for shipping @architect projects to the cloud
- Host: GitHub
- URL: https://github.com/architect/deploy
- Owner: architect
- License: apache-2.0
- Created: 2019-07-11T13:25:06.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T21:42:50.000Z (over 1 year ago)
- Last Synced: 2025-04-02T09:08:00.097Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://arc.codes
- Size: 1.04 MB
- Stars: 7
- Watchers: 2
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: .github/contributing.md
- License: LICENSE
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
[
](https://www.npmjs.com/package/@architect/deploy)
## [`@architect/deploy`](https://www.npmjs.com/package/@architect/deploy)
> Architect serverless framework module for deploying applications to cloud infrastructure
[](https://github.com/architect/deploy/actions?query=workflow%3A%22Node+CI%22)
## Installation
npm i @architect/deploy
let deploy = require('@architect/deploy')
## Requirements
You need to have the `sam` command-line utility available on your `$PATH`. Check out [AWS' docs][sam-cli] for instructions on how to install this.
## API
### `deploy.direct({ isDryRun, srcDirs }, callback)`
Deploys function code directly to one or more staging (or production) environment Lambdas _by ommitting CloudFormation and directly updating code payloads_. This is very useful for live debugging; changes made with direct deploys should be considered temporary.
### `deploy.sam({ verbose, production }, callback)`
Deploys all infrastructure associated to your @architect app.
Set `verbose` to truthy to enable chatty mode. By default will only push to the staging environment unless `production` is truthy.
### `deploy.static({ bucket, credentials, fingerprint, prefix, prune, region, verbose, production }, callback)`
All parameters are optional.
Pushes static assets from the `public/` folder of @architect apps to S3, as defined by your @architect app's `.arc` file. Respects `fingerprint` (`true` or `external`), `prefix`, `prune`, and `ignore` params or `@static` pragma directives (more information available on the [`@static` arc guide][static-guide]).
By default will only publish to the staging environment unless `production` is truthy. Set `verbose` to truthy to enable chatty mode.
[static-guide]: https://arc.codes/reference/static
[sam-cli]: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html
### `aws-sdk` caveat
Deploy requires `aws-sdk`; earlier versions included `aws-sdk` in `peerDependencies`, which prior to npm 7 would not automatically install `aws-sdk`. This is because Architect assumes you already have `aws-sdk` installed via Architect, or that it's available at runtime if you're using Deploy in a Lambda.
However, npm 7 (once again) changed the behavior of `peerDependencies`, now automatically installing all `peerDependencies` (instead of merely printing a reminder). This means any Lambdas that use Deploy would get a >50MB dependency payload if deployed on a machine with npm 7.
As such, please ensure `aws-sdk` is installed to your project or globally to your machine. We are sorry to make this a userland issue, but we feel this is preferable to unnecessarily and invisibly causing `aws-sdk` to be double-installed in Lambdas, negatively impacting coldstart times and adding to bug vectors.