{"id":22763554,"url":"https://github.com/mearns/sirocco","last_synced_at":"2026-02-11T07:32:49.253Z","repository":{"id":34977953,"uuid":"191595635","full_name":"mearns/sirocco","owner":"mearns","description":"A node library to assist in deploying cloudformation stacks","archived":false,"fork":false,"pushed_at":"2023-03-04T03:54:55.000Z","size":1073,"stargazers_count":2,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-27T10:36:46.108Z","etag":null,"topics":["amazon","aws","cfn","cloud","cloudformation","deploy","javascript","nodejs"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mearns.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.yaml","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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,"zenodo":null}},"created_at":"2019-06-12T15:15:43.000Z","updated_at":"2021-08-27T13:38:25.000Z","dependencies_parsed_at":"2025-08-20T15:32:47.508Z","dependency_job_id":null,"html_url":"https://github.com/mearns/sirocco","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":"mearns/node-template","purl":"pkg:github/mearns/sirocco","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mearns%2Fsirocco","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mearns%2Fsirocco/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mearns%2Fsirocco/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mearns%2Fsirocco/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mearns","download_url":"https://codeload.github.com/mearns/sirocco/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mearns%2Fsirocco/sbom","scorecard":{"id":569145,"data":{"date":"2025-08-11","repo":{"name":"github.com/mearns/sirocco","commit":"747fa138a051976c3b66169489598c8acc67f1ae"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/19 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"18 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T15:50:40.289Z","repository_id":34977953,"created_at":"2025-08-20T15:50:40.290Z","updated_at":"2025-08-20T15:50:40.290Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29329493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["amazon","aws","cfn","cloud","cloudformation","deploy","javascript","nodejs"],"created_at":"2024-12-11T11:09:01.089Z","updated_at":"2026-02-11T07:32:49.230Z","avatar_url":"https://github.com/mearns.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sirocco\n\nA node command line utility and library to assist in deploying AWS CloudFormation stacks.\n\nDeploying any non-trivial CloudFormation stack requires managing parameter values,\nstack names, tags, etc. When any of this is dynamic, like when deploying to multiple\nenvironments/stages, sticking these commands in `package.json` isn't very practical.\n\nSirocco manages one or more stacks across multiple environments, generating commands,\nparameter values, stack names, etc., based on a simple (and optional) configuration\nfile.\n\nThe \"Quick Start\" below is meant as a quick reminder for when you already know how to\nuse this package; to actually get started, take a look at [Getting Started](docs/getting-started.md).\n\n## Requirements\n\nThis requires the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)\nbe installed and executable from your path.\n\nCurrently, only YAML is supported from CloudFormation stack templates.\n\n## Quick Start\n\n### install\n\n```console\n\u003e npm install --save-dev sirocco\n```\n\n### Basic CLI Usage\n\n```console\n\u003e sirocco (deploy|teardown) [DEPLOY_TYPE] [options]\n```\n\n### Directory Layout\n\n```ASCII\n./\n└── stacks/\n    ├── queue/\n    │   └── stack.yml\n    ├── lambda/\n    │   └── stack.yml\n    └── test/\n        └── stack.yml\n```\n\n## Config\n\nSpecify optional config at `.sirocco.js`:\n\n```js\nmodule.exports = {\n    options: {\n        /* command-line-ish options */\n    },\n\n    // The default set of stacks to deploy if none are specified with the --stacks option.\n    defaultStacks: [\"queue\", \"lambda\"],\n\n    // Base configuration shared by all deploy types and envs.\n    global: {\n        params: {\n            suite: \"Sirocco\",\n            app: \"SiroccoDemo\",\n            isTest: false\n        }\n    },\n\n    // A dictionary of known deploy types.\n    deployTypes: {\n        dev: {\n            validEnvs: /dev-[a-z0-9-]+/,\n            role: \"NONPROD_ROLE\",\n            params: {\n                nodeEnv: \"development\"\n            }\n        },\n        prod: {\n            role: \"PROD_ROLE\",\n            validEnvs: /prod-[0-9]+/,\n            params: {\n                nodeEnv: \"production\"\n            }\n        }\n    },\n\n    envs: {\n        \"dev-test\": {\n            params: {\n                isTest: true\n            }\n        }\n    }\n};\n```\n\n### Async Configuration Module\n\nIf your config file exports a function, instead of an object, it will be invoked without any arguments\nand treated as an `async` function. This allows your config module to do asynchronous things like read\nfrom file before returning the actual sirocco config object.\n\n### Dynamic Configuration\n\nParameters and most of configuration options are resolved dynamically for each stack and environment, so a single\nconfiguration object can provide dynamic values based on the stack or environment name. The following shows\nsome example of dynamic parameters:\n\n```javascript\nmodule.exports = {\n    global: {\n        params: {\n            constant: \"value\",\n\n            foo: (stackName, envName, parameters) =\u003e {\n                /* derive the value of the \"foo\" parameter for this stack/env */\n            },\n\n            bar:\n                \"The bar parameter value for stack {stack} in the {env} environment\",\n\n            baz: \"Derived-From-Other-Params-{constant}\",\n\n            trot: () =\u003e \"A parameter value with literal brackets in it: {foo}\"\n        }\n    }\n};\n```\n\nAs shown, dynamic parameter values can either be functions (as in \"foo\" and \"trot\", above) or string templates\n(as in \"bar\" and \"baz\").\n\n#### Functions\n\nFunctions are invoked with three parameters:\n\n-   The name of the stack being targeted (see below)\n-   The name of the environment\n-   A dictionary of _unresolved_ parameters.\n\nNote that the first argument, the name of the stack, is the _local_ name of the stack (i.e., the name of the stack's\ndirectory under `stacks/`), _not_ the generated name of the cloudformation stack.\n\nThe third argument is a dictionary (a plain object) of the parameters for the stack, _without_ resolving any of\nthe parameter values. Thus, e.g., the \"foo\" property of this dictionary, in the above examples, would be the `foo` function\nitself, _not_ the resulting value.\n\nThe dictionary is _first_ populateed with two items: _stack_ and _env_, which are the same as the values passed in for the first\ntwo arguments. However, you happen to have parameters named \"stack\" or \"env\", then these entries will be overwritten in the dictionary\nwith the (unresolved) parameter values.\n\n#### String Templates\n\nString values are assumed to be [string-templates](https://www.npmjs.com/package/string-template) which use curly braces\nto denote place holders to be replaced. These templates are resolved with the same dictionary that is passed as the third\nargument to function values (described above), which is the unresolved parameter values with the added default properties\nof _stack_ and _env_.\n\nIf your parameter value has literal pairs of curly braces that you want to include in the value, you can escape them by\ndoubling the braces. You can also make it unambiguous by defining the value as a function which returns the string value you\nwant: returned value are _never_ treated as string-templates.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmearns%2Fsirocco","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmearns%2Fsirocco","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmearns%2Fsirocco/lists"}