{"id":14986005,"url":"https://github.com/ably-labs/ably-control-api-action","last_synced_at":"2026-01-19T00:32:28.236Z","repository":{"id":43182836,"uuid":"445508931","full_name":"ably-labs/ably-control-api-action","owner":"ably-labs","description":"A GitHub Action to use the Ably Control API.","archived":false,"fork":false,"pushed_at":"2023-10-19T20:33:56.000Z","size":171,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-02T19:49:12.114Z","etag":null,"topics":["actions"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"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/ably-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2022-01-07T12:10:25.000Z","updated_at":"2022-09-05T17:50:53.000Z","dependencies_parsed_at":"2024-09-29T23:41:09.390Z","dependency_job_id":"f1072d41-4eab-44d3-bce2-e40599b540da","html_url":"https://github.com/ably-labs/ably-control-api-action","commit_stats":{"total_commits":70,"total_committers":5,"mean_commits":14.0,"dds":"0.30000000000000004","last_synced_commit":"ab831847390fdc03631d83064edebe1dde78d7af"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/ably-labs/ably-control-api-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably-labs%2Fably-control-api-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably-labs%2Fably-control-api-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably-labs%2Fably-control-api-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably-labs%2Fably-control-api-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ably-labs","download_url":"https://codeload.github.com/ably-labs/ably-control-api-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably-labs%2Fably-control-api-action/sbom","scorecard":{"id":161257,"data":{"date":"2025-08-11","repo":{"name":"github.com/ably-labs/ably-control-api-action","commit":"ab831847390fdc03631d83064edebe1dde78d7af"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/24 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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/all_inputs_test.yml:1","Warn: no topLevel permission defined: .github/workflows/required_inputs_test.yml:1","Info: no jobLevel write permissions found"],"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":"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/all_inputs_test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ably-labs/ably-control-api-action/all_inputs_test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/required_inputs_test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ably-labs/ably-control-api-action/required_inputs_test.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: 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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"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":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 13 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"}}]},"last_synced_at":"2025-08-16T13:30:29.438Z","repository_id":43182836,"created_at":"2025-08-16T13:30:29.438Z","updated_at":"2025-08-16T13:30:29.438Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28554394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T23:48:35.235Z","status":"ssl_error","status_checked_at":"2026-01-18T23:47:49.178Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["actions"],"created_at":"2024-09-24T14:12:07.355Z","updated_at":"2026-01-19T00:32:28.221Z","avatar_url":"https://github.com/ably-labs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ably Control API Action\n\n![Required Inputs Workflow](https://github.com/ably-labs/ably-control-api-action/actions/workflows/required_inputs_test.yml/badge.svg)\n![All Inputs Workflow](https://github.com/ably-labs/ably-control-api-action/actions/workflows/all_inputs_test.yml/badge.svg)\n\nA GitHub Action to use the [Ably Control API](https://ably.com/documentation/control-api). You can use this action to:\n\n* Create an Ably application.\n* Add an API key to an application, with a list of capabilities.\n\n![Control API GitHub Action diagram](ably-control-api-action.png)\n\n## Usage\n\n### Inputs\n\nThe action has the following inputs:\n\n* `account-id` (**required**); the Ably account ID, see [these instructions](https://ably.com/documentation/control-api#account-id) how to obtain this.\n* `control-api-key`  (**required**); an Ably Control API key, see [these instructions](https://ably.com/documentation/control-api#authentication) how to create one. This key needs the following permissions:\n  * `read:app`\n  * `write:app`\n  * `read:key`\n  * `write:key`\n* `app-name` (**optional**); the name for the Ably app to create. Defaults to the repository name.\n* `create-key` (**optional**); a boolean value indicating whether to create an API key for the new app. Defaults to `'true'`.\n* `key-name` (**optional**); the friendly name for the API key. Defaults to `'Generated API key'`.\n* `key-capabilities` (**optional**); a comma-separated list of capabilities to grant to the new key. Defaults to `'publish, subscribe'`. These are the available capabilities:\n  * `channel-metadata`,\n  * `history`,\n  * `presence`,\n  * `publish`,\n  * `push-admin`,\n  * `push-subscribe`,\n  * `statistics`,\n  * `subscribe`\n\n  For details of these capabilities see the [Ably docs](https://ably.com/documentation/core-features/authentication#capability-operations).\n\nIt is important to keep the `account-id` and `control-api-key` inputs secret, as they are used to authenticate with the Ably Control API. Put these values in [GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) of your repository and read the secret values when configuring the inputs of this action (see the examples below).\n\n### Outputs\n\n* `app-name`; the name of the created Ably app.\n* `app-id`; the ID of the created Ably app.\u003csup\u003e*\u003c/sup\u003e\n* `api-key-name`; the name of the created API key.\n* `api-key-id`; the ID of the created API key.\u003csup\u003e*\u003c/sup\u003e\n* `api-key-key`; the key value of the created API key. \u003csup\u003e*\u003c/sup\u003e\n\n\u003e (*) Output is marked as a secret, so it won't be visible in the GitHub workflow logs.\n\n### Examples\n\n#### Using only the required inputs\n\n```yml\n- name: Create Ably App\n  id: ablyapp\n  uses: ably-labs/ably-control-api-action@v0.1.6\n  with:\n    account-id: '${{ secrets.ABLY_ACCOUNT_ID }}'\n    control-api-key: '${{ secrets.ABLY_CONTROL_API_KEY }}'\n- name: Get the output\n  run: |\n    echo \"App Name: ${{ steps.ablyapp.outputs.app-name }}\"\n    echo \"App ID: ${{ steps.ablyapp.outputs.app-id }}\"\n    echo \"API Key Name: ${{ steps.ablyapp.outputs.api-key-name }}\"\n```\n\n#### Using all inputs\n\n```yml\n- name: Create Ably App\n  id: ablyapp\n  uses: ably-labs/ably-control-api-action@v0.1.6\n  with:\n      account-id: '${{ secrets.ABLY_ACCOUNT_ID }}'\n      control-api-key: '${{ secrets.ABLY_CONTROL_API_KEY }}'\n      app-name: 'ably-control-api-key-all-inputs'\n      create-key: 'true'\n      key-name: 'all inputs api key'\n      key-capabilities: 'publish, subscribe, presence, history'\n- name: Get the output\n  run: |\n    echo \"App Name: ${{ steps.ablyapp.outputs.app-name }}\"\n    echo \"App ID: ${{ steps.ablyapp.outputs.app-id }}\"\n    echo \"API Key Name: ${{ steps.ablyapp.outputs.api-key-name }}\"\n```\n\n## More information\n\nTo learn more about Infrastructure as Code, GitHub workflows \u0026 actions read [this blog post](https://ably.com/blog/infrastructure-as-code-ably-control-api-github-action).\n\nFor more information about the Ably Control API please see the [Ably docs](https://ably.com/documentation/control-api).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably-labs%2Fably-control-api-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fably-labs%2Fably-control-api-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably-labs%2Fably-control-api-action/lists"}