{"id":5791805,"name":"Staffbase/backstage-techdocs-action","ecosystem":"actions","description":"Generate and publish Backstage TechDocs.","homepage":"","licenses":"apache-2.0","normalized_licenses":["Apache-2.0"],"repository_url":"https://github.com/Staffbase/backstage-techdocs-action","keywords_array":["actions","backstage","github-actions"],"namespace":"Staffbase","versions_count":6,"first_release_published_at":"2022-09-07T13:26:53.000Z","latest_release_published_at":"2025-11-04T09:55:31.000Z","latest_release_number":"v0.2.3","last_synced_at":"2026-03-18T14:01:39.972Z","created_at":"2023-01-03T21:46:49.957Z","updated_at":"2026-03-18T14:01:39.972Z","registry_url":"https://github.com/Staffbase/backstage-techdocs-action","install_command":null,"documentation_url":null,"metadata":{"name":"Backstage TechDocs","description":"Generate and publish Backstage TechDocs.","author":"Staffbase GmbH","inputs":{"entity-namespace":{"description":"Entity Namespace","required":true,"default":"default"},"entity-kind":{"description":"Entity Kind","required":true,"default":"Component"},"entity-name":{"description":"Entity Name","required":true},"publisher-type":{"description":"awsS3 | azureBlobStorage","required":false},"storage-name":{"description":"In case of AWS/GCS, use the bucket name. In case of Azure, use container name.","required":false},"aws-region":{"description":"AWS Region","required":false,"default":"eu-central-1"},"aws-access-key-id":{"description":"AWS Access Key ID","required":false},"aws-secret-access-key":{"description":"AWS Secret Access Key","required":false},"azure-account-name":{"description":"Azure Account Name","required":false},"azure-account-key":{"description":"Azure Account Key","required":false},"additional-plugins":{"description":"List of additional python plugins to use for site creation","required":false},"skip-publish":{"description":"Indicates whether publish step should be skipped","required":false,"default":"false"}},"runs":{"using":"composite","steps":[{"name":"Validate inputs","shell":"bash","run":"if [[ -z \"${{ inputs.entity-name }}\" ]]; then\n  echo \"::error::entity-name is required\"\n  exit 1\nfi\n\nif [[ \"${{ inputs.skip-publish }}\" == \"false\" ]]; then\n  if [[ -z \"${{ inputs.publisher-type }}\" ]]; then\n    echo \"::error::publisher-type is required when skip-publish is false\"\n    exit 1\n  fi\n  \n  if [[ \"${{ inputs.publisher-type }}\" == \"awsS3\" ]]; then\n    if [[ -z \"${{ inputs.storage-name }}\" || -z \"${{ inputs.aws-access-key-id }}\" || -z \"${{ inputs.aws-secret-access-key }}\" ]]; then\n      echo \"::error::storage-name, aws-access-key-id, and aws-secret-access-key are required for AWS S3 publishing\"\n      exit 1\n    fi\n  elif [[ \"${{ inputs.publisher-type }}\" == \"azureBlobStorage\" ]]; then\n    if [[ -z \"${{ inputs.storage-name }}\" || -z \"${{ inputs.azure-account-name }}\" || -z \"${{ inputs.azure-account-key }}\" ]]; then\n      echo \"::error::storage-name, azure-account-name, and azure-account-key are required for Azure Blob Storage publishing\"\n      exit 1\n    fi\n  else\n    echo \"::error::publisher-type must be 'awsS3' or 'azureBlobStorage', got '${{ inputs.publisher-type }}'\"\n    exit 1\n  fi\nfi\n"},{"name":"Setup Node","uses":"actions/setup-node@v5","with":{"node-version":"22"}},{"name":"Setup Python","uses":"actions/setup-python@v6","with":{"python-version":"3.12"}},{"name":"Install mkdocs and mkdocs plugins","shell":"bash","run":"python -m pip install mkdocs-techdocs-core==1.*"},{"name":"Install additional plugins","if":"inputs.additional-plugins != ''","shell":"bash","run":"for p in ${{ inputs.additional-plugins }}\ndo\n  python -m pip install $p\ndone\n"},{"name":"Generate docs site","shell":"bash","run":"npx @techdocs/cli generate --no-docker --verbose"},{"name":"Publish TechDocs site to AWS S3","if":"inputs.skip-publish == 'false' \u0026\u0026 inputs.publisher-type == 'awsS3' \u0026\u0026 inputs.aws-access-key-id != '' \u0026\u0026 inputs.aws-secret-access-key != '' \u0026\u0026 inputs.aws-region != ''","shell":"bash","env":{"AWS_ACCESS_KEY_ID":"${{ inputs.aws-access-key-id }}","AWS_SECRET_ACCESS_KEY":"${{ inputs.aws-secret-access-key }}","AWS_REGION":"${{ inputs.aws-region }}"},"run":"npx @techdocs/cli publish --publisher-type ${{ inputs.publisher-type }} \\\n--storage-name ${{ inputs.storage-name }} \\\n--entity ${{ inputs.entity-namespace }}/${{ inputs.entity-kind }}/${{ inputs.entity-name }}\n"},{"name":"Publish TechDocs site to Azure Blob","if":"inputs.skip-publish == 'false' \u0026\u0026 inputs.publisher-type == 'azureBlobStorage' \u0026\u0026 inputs.azure-account-name != '' \u0026\u0026 inputs.azure-account-key != ''","shell":"bash","run":"npx @techdocs/cli publish --publisher-type ${{ inputs.publisher-type }} \\\n--storage-name ${{ inputs.storage-name }} \\\n--entity ${{ inputs.entity-namespace }}/${{ inputs.entity-kind }}/${{ inputs.entity-name }} \\\n--azureAccountName ${{ inputs.azure-account-name }} \\\n--azureAccountKey ${{ inputs.azure-account-key }}\n"}]},"branding":{"icon":"check-square","color":"blue"},"default_branch":"main","path":null},"repo_metadata":{"id":65158485,"uuid":"515072426","full_name":"Staffbase/backstage-techdocs-action","owner":"Staffbase","description":"GitHub Action for creating and publishing Backstage TechDocs.","archived":false,"fork":false,"pushed_at":"2026-02-02T08:13:45.000Z","size":128,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":17,"default_branch":"main","last_synced_at":"2026-03-18T01:54:13.770Z","etag":null,"topics":["actions","backstage","github-actions"],"latest_commit_sha":null,"homepage":"","language":null,"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/Staffbase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":"CLA.md"}},"created_at":"2022-07-18T07:08:03.000Z","updated_at":"2026-02-02T08:13:47.000Z","dependencies_parsed_at":"2023-11-30T16:26:42.490Z","dependency_job_id":"45caa6f5-610a-4696-9e37-0c5808d23087","html_url":"https://github.com/Staffbase/backstage-techdocs-action","commit_stats":{"total_commits":14,"total_committers":6,"mean_commits":"2.3333333333333335","dds":0.6428571428571428,"last_synced_commit":"b9e66cffef4ed5467826c06fe51377049dc524be"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/Staffbase/backstage-techdocs-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Staffbase%2Fbackstage-techdocs-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Staffbase%2Fbackstage-techdocs-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Staffbase%2Fbackstage-techdocs-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Staffbase%2Fbackstage-techdocs-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Staffbase","download_url":"https://codeload.github.com/Staffbase/backstage-techdocs-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Staffbase%2Fbackstage-techdocs-action/sbom","scorecard":{"id":133583,"data":{"date":"2025-08-11","repo":{"name":"github.com/Staffbase/backstage-techdocs-action","commit":"f23e1c4b66d911de478c162261a24265dff8d1fc"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"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":"Code-Review","score":5,"reason":"Found 2/4 approved changesets -- score normalized to 5","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":"Maintained","score":3,"reason":"4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3","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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-merge.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/Staffbase/backstage-techdocs-action/auto-merge.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/cla.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Staffbase/backstage-techdocs-action/cla.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Staffbase/backstage-techdocs-action/release.yml/main?enable=pin","Info:   0 out of   3 third-party 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/auto-merge.yml:1","Warn: no topLevel permission defined: .github/workflows/cla.yml:1","Warn: no topLevel permission defined: .github/workflows/release.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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"SAST","score":-1,"reason":"internal error: internal error: Client.Checks.ListCheckRunsForRef: error during graphqlHandler.setupCheckRuns: Something went wrong while executing your query on 2025-08-12T14:43:16Z. Please include `C31E:728F2:7B2780:1B99A6E:689B5303` when reporting this issue.","details":null,"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Branch-Protection","score":1,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Warn: 'force pushes' enabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Info: codeowner review is required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: 'up-to-date branches' is disabled on branch 'main'","Info: status check found to merge onto on branch 'main'","Info: PRs are required in order to make changes on 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"}}]},"last_synced_at":"2025-08-16T05:48:03.871Z","repository_id":65158485,"created_at":"2025-08-16T05:48:03.871Z","updated_at":"2025-08-16T05:48:03.871Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30666120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-18T11:38:23.016Z","status":"ssl_error","status_checked_at":"2026-03-18T11:34:02.227Z","response_time":104,"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"},"owner_record":{"login":"Staffbase","name":"Staffbase","uuid":"22979386","kind":"organization","description":"The no. 1 employee app platform. Trusted by hundreds of internal comms professionals. ✓ Own branding ✓ Turnkey solution ✓ API \u0026 Integrations ✓ Fair pricing","email":"hi@staffbase.com","website":"https://staffbase.com","location":"Germany","twitter":null,"company":null,"icon_url":"https://avatars.githubusercontent.com/u/22979386?v=4","repositories_count":67,"last_synced_at":"2024-04-15T14:41:41.560Z","metadata":{"has_sponsors_listing":false},"html_url":"https://github.com/Staffbase","funding_links":[],"total_stars":88,"followers":91,"following":0,"created_at":"2022-11-08T22:01:38.147Z","updated_at":"2024-04-15T14:41:56.201Z","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Staffbase","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Staffbase/repositories"},"tags":[]},"repo_metadata_updated_at":"2026-03-18T14:01:20.470Z","dependent_packages_count":0,"downloads":null,"downloads_period":null,"dependent_repos_count":1,"rankings":{"downloads":null,"dependent_repos_count":24.753604816986215,"dependent_packages_count":0.0,"stargazers_count":34.63159562668357,"forks_count":35.11012517826018,"docker_downloads_count":null,"average":23.62383140548249},"purl":"pkg:githubactions/Staffbase/backstage-techdocs-action","advisories":[],"docker_usage_url":"https://docker.ecosyste.ms/usage/actions/Staffbase/backstage-techdocs-action","docker_dependents_count":null,"docker_downloads_count":null,"usage_url":"https://repos.ecosyste.ms/usage/actions/Staffbase/backstage-techdocs-action","dependent_repositories_url":"https://repos.ecosyste.ms/api/v1/usage/actions/Staffbase/backstage-techdocs-action/dependencies","status":null,"funding_links":[],"critical":null,"issue_metadata":{"last_synced_at":"2026-02-02T11:00:44.367Z","issues_count":0,"pull_requests_count":56,"avg_time_to_close_issue":null,"avg_time_to_close_pull_request":181647.98076923078,"issues_closed_count":0,"pull_requests_closed_count":52,"pull_request_authors_count":6,"issue_authors_count":0,"avg_comments_per_issue":null,"avg_comments_per_pull_request":0.375,"merged_pull_requests_count":51,"bot_issues_count":0,"bot_pull_requests_count":41,"past_year_issues_count":0,"past_year_pull_requests_count":7,"past_year_avg_time_to_close_issue":null,"past_year_avg_time_to_close_pull_request":18596.6,"past_year_issues_closed_count":0,"past_year_pull_requests_closed_count":5,"past_year_pull_request_authors_count":2,"past_year_issue_authors_count":0,"past_year_avg_comments_per_issue":null,"past_year_avg_comments_per_pull_request":0.42857142857142855,"past_year_bot_issues_count":0,"past_year_bot_pull_requests_count":5,"past_year_merged_pull_requests_count":5,"issues_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/Staffbase%2Fbackstage-techdocs-action/issues","maintainers":[{"login":"axdotl","count":6,"url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors/axdotl"},{"login":"flaxel","count":2,"url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors/flaxel"}],"active_maintainers":[]},"versions_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/Staffbase%2Fbackstage-techdocs-action/versions","version_numbers_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/Staffbase%2Fbackstage-techdocs-action/version_numbers","dependent_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/Staffbase%2Fbackstage-techdocs-action/dependent_packages","related_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/Staffbase%2Fbackstage-techdocs-action/related_packages","codemeta_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/Staffbase%2Fbackstage-techdocs-action/codemeta","maintainers":[]}