{"id":20290654,"url":"https://github.com/gocardless/publish-techdocs-action","last_synced_at":"2026-06-03T22:31:03.028Z","repository":{"id":46863699,"uuid":"369129933","full_name":"gocardless/publish-techdocs-action","owner":"gocardless","description":"Action to generate and publish TechDocs","archived":false,"fork":false,"pushed_at":"2024-08-27T09:39:20.000Z","size":26,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2026-05-28T14:29:14.023Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/gocardless.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-05-20T08:05:21.000Z","updated_at":"2024-08-27T09:05:40.000Z","dependencies_parsed_at":"2023-11-23T11:33:04.223Z","dependency_job_id":"d6e07638-d997-43fa-b37b-3b92be3afa2e","html_url":"https://github.com/gocardless/publish-techdocs-action","commit_stats":{"total_commits":12,"total_committers":4,"mean_commits":3.0,"dds":0.5833333333333333,"last_synced_commit":"08ba7c0b67938b05f07b7a109ea6aba46996082d"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/gocardless/publish-techdocs-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fpublish-techdocs-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fpublish-techdocs-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fpublish-techdocs-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fpublish-techdocs-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gocardless","download_url":"https://codeload.github.com/gocardless/publish-techdocs-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fpublish-techdocs-action/sbom","scorecard":{"id":433125,"data":{"date":"2025-08-11","repo":{"name":"github.com/gocardless/publish-techdocs-action","commit":"8658c2cda4dea4aa9d18cb118c4ec0264bd2b337"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.2,"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":8,"reason":"Found 13/15 approved changesets -- score normalized to 8","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":"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":"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":"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":"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating spotify/techdocs:v1.2.3 to spotify/techdocs:v1.2.3@sha256:fe8314afaefad900dfe61b1ca81bf7ddd47f68c2b1872a7f34547ca297f7d6b9","Warn: npmCommand not pinned by hash: Dockerfile:5","Warn: pipCommand not pinned by hash: Dockerfile:7-10","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned","Info:   0 out of   1 pipCommand 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":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/gocardless/.github/SECURITY.md:1","Info: Found linked content: github.com/gocardless/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/gocardless/.github/SECURITY.md:1","Info: Found text in security policy: github.com/gocardless/.github/SECURITY.md:1"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 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-19T03:51:38.640Z","repository_id":46863699,"created_at":"2025-08-19T03:51:38.640Z","updated_at":"2025-08-19T03:51:38.640Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33883102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-03T02:00:06.370Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-14T15:08:37.357Z","updated_at":"2026-06-03T22:31:03.010Z","avatar_url":"https://github.com/gocardless.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Generate and Publish TechDocs to GCS\n\n**EXPERIMENTAL: Use at own risk**\n\n\u003e [GitHub Action](https://github.com/features/actions) for [Publishing TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)\n\n[![GitHub Release][release-img]][release]\n[![GitHub Marketplace][marketplace-img]][marketplace]\n[![License][license-img]][license]\n\n## Table of Contents\n\n- [Usage](#usage)\n  - [Workflow](#workflow)\n\n## Usage\n\n### Workflow\n\n```yaml\nname: publish-techdocs\non:\n  push:\n    branches:\n      - master\n    paths:\n      - docs/**\njobs:\n  publish-techdocs:\n    name: Publish Techdocs\n    runs-on: ubuntu-latest\n    strategy:\n      matrix:\n        n:\n          - env: staging\n            secret: TECHDOCS_GCS_SECRET_ACCESS_KEY_STAGING\n          - env: production\n            secret: TECHDOCS_GCS_SECRET_ACCESS_KEY_PRODUCTION\n    steps:\n      - uses: actions/checkout@v3\n      - name: Publish TechDocs - ${{ matrix.n.env }}\n        uses: gocardless/publish-techdocs-action@master\n        with:\n          publisher: googleGcs\n          credentials: ${{ secrets[matrix.n.secret] }}\n          bucket: gc-prd-tech-docs-${{ matrix.n.env }}\n          entity: default/component/\u003cYOUR_SERVICE_NAME_GOES_HERE\u003e\n```\n\n\n[release]: https://github.com/gocardless/publish-techdocs-action/releases/latest\n[release-img]: https://img.shields.io/github/release/gocardless/publish-techdocs-action?include_prereleases\u0026color=blue\n[marketplace]: https://github.com/marketplace/actions/publish-techdocs\n[marketplace-img]: https://img.shields.io/badge/marketplace-publish--techdocs-blue?logo=github\n[license]: https://github.com/gocardless/publish-techdocs-action/blob/master/LICENSE\n[license-img]: https://img.shields.io/github/license/gocardless/publish-techdocs-action\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fpublish-techdocs-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgocardless%2Fpublish-techdocs-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fpublish-techdocs-action/lists"}