{"id":19437851,"url":"https://github.com/architect/deploy","last_synced_at":"2025-04-09T10:10:15.265Z","repository":{"id":35012310,"uuid":"196399712","full_name":"architect/deploy","owner":"architect","description":"Deployment module for shipping @architect projects to the cloud","archived":false,"fork":false,"pushed_at":"2025-01-23T21:42:50.000Z","size":1094,"stargazers_count":7,"open_issues_count":3,"forks_count":21,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T09:08:00.097Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://arc.codes","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/architect.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":".github/code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-11T13:25:06.000Z","updated_at":"2025-01-23T21:42:53.000Z","dependencies_parsed_at":"2023-02-16T23:25:17.922Z","dependency_job_id":"4956d959-8854-44a7-b5c6-e442ec8f7ef5","html_url":"https://github.com/architect/deploy","commit_stats":{"total_commits":830,"total_committers":13,"mean_commits":63.84615384615385,"dds":"0.36265060240963853","last_synced_commit":"202f8404618bffcf7d4ae90562aaf51be8d921a7"},"previous_names":[],"tags_count":231,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fdeploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fdeploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fdeploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architect%2Fdeploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/architect","download_url":"https://codeload.github.com/architect/deploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018061,"owners_count":21034048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T15:16:04.431Z","updated_at":"2025-04-09T10:10:15.209Z","avatar_url":"https://github.com/architect.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg src=\"https://assets.arc.codes/architect-logo-500b@2x.png\" width=500\u003e](https://www.npmjs.com/package/@architect/deploy)\n\n## [`@architect/deploy`](https://www.npmjs.com/package/@architect/deploy)\n\n\u003e Architect serverless framework module for deploying applications to cloud infrastructure\n\n[![GitHub CI status](https://github.com/architect/deploy/workflows/Node%20CI/badge.svg)](https://github.com/architect/deploy/actions?query=workflow%3A%22Node+CI%22)\n\n\n## Installation\n\n    npm i @architect/deploy\n    let deploy = require('@architect/deploy')\n\n\n## Requirements\n\nYou 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.\n\n\n## API\n\n### `deploy.direct({ isDryRun, srcDirs }, callback)`\n\nDeploys 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.\n\n\n### `deploy.sam({ verbose, production }, callback)`\n\nDeploys all infrastructure associated to your @architect app.\n\nSet `verbose` to truthy to enable chatty mode. By default will only push to the staging environment unless `production` is truthy.\n\n\n### `deploy.static({ bucket, credentials, fingerprint, prefix, prune, region, verbose, production }, callback)`\n\nAll parameters are optional.\n\nPushes 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]).\n\nBy default will only publish to the staging environment unless `production` is truthy. Set `verbose` to truthy to enable chatty mode.\n\n[static-guide]: https://arc.codes/reference/static\n[sam-cli]: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html\n\n\n### `aws-sdk` caveat\n\nDeploy 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.\n\nHowever, 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 \u003e50MB dependency payload if deployed on a machine with npm 7.\n\nAs 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitect%2Fdeploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchitect%2Fdeploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitect%2Fdeploy/lists"}