{"id":21417340,"url":"https://github.com/staffbase/backstage-techdocs-action","last_synced_at":"2025-03-16T19:19:33.183Z","repository":{"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":"2024-04-01T19:50:09.000Z","size":74,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":16,"default_branch":"main","last_synced_at":"2024-04-14T12:55:13.597Z","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}},"created_at":"2022-07-18T07:08:03.000Z","updated_at":"2024-04-18T14:42:50.502Z","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":5,"template":false,"template_full_name":null,"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","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243918629,"owners_count":20368745,"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":["actions","backstage","github-actions"],"created_at":"2024-11-22T19:14:42.327Z","updated_at":"2025-03-16T19:19:33.146Z","avatar_url":"https://github.com/Staffbase.png","language":null,"readme":"# 📖 GitHub Action for Backstage TechDocs\n\nThis GitHub Action can be used for generating and publishing [Backstage TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview).\n\n## Features\n\nThe action facilitated [TechDocs CLI](https://backstage.io/docs/features/techdocs/cli) to generate and publish TechDocs sites.\n\n- Building TechDocs only\n- Building and publish TechDocs to cloud object storage\n  - [AWS S3](https://aws.amazon.com/s3/)\n  - [Azure Blob](https://azure.microsoft.com/en-us/services/storage/blobs/)\n\n## Usage\n\n### Minimal Example\n\nThe following shows a minimal example of building and publishing TechDocs to AWS S3.\n\n```yaml\nname: Publish TechDocs Site\n\non:\n  push:\n    branches:\n      - main\n    paths:\n      - \"docs/**\"\n      - \"mkdocs.yml\"\n      - \".github/workflows/techdocs.yml\"\n\njobs:\n  publish-techdocs-site:\n    name: Publish TechDocs Site\n    runs-on: ubuntu-20.04\n    steps:\n      - name: Setup Node\n        uses: Staffbase/backstage-techdocs-action@v1\n        with:\n          entity-name: 'pizza-service'\n          publisher-type: 'azureBlobStorage'\n          storage-name: 'techdocs'\n          azure-account-name: ${{ secrets.TECHDOCS_AZURE_ACCOUNT_NAME }}\n          azure-account-key: ${{ secrets.TECHDOCS_AZURE_ACCESS_KEY }}\n```\n\n### Advanced Example\n\nThe following will skip the publish step (e.g. to verify site generation in a pull request) and installs additional plugins:\n\n```yaml\nname: Publish TechDocs Site\n\non:\n  push:\n    paths:\n      - \"docs/**\"\n      - \"mkdocs.yml\"\n      - \".github/workflows/techdocs.yml\"\n\njobs:\n  publish-techdocs-site:\n    name: Publish TechDocs Site\n    runs-on: ubuntu-20.04\n    steps:\n      - name: Setup Node\n        uses: Staffbase/backstage-techdocs-action@v1\n        with:\n          entity-name: 'pizza-service'\n          additional-plugins: 'mkdocs-minify-plugin\\\u003e=0.3 mkdocs-awesome-pages-plugin==2.8.0 mdx_include==1.4.2'\n          skip-publish: 'true'\n```\n\n## Configuration\n\n| Name                    | Description                                                                        | Required | Default        |\n| ----------------------- | ---------------------------------------------------------------------------------- | -------- | -------------- |\n| `entity-namespace`      | Entity namespace in Backstage                                                      | `true`   | `default`      |\n| `entity-kind`           | Kind of the Backstage entity                                                       | `true`   | `Component`    |\n| `entity-name`           | Name of the Backstage entity                                                       | `true`   |                |\n| `publisher-type`        | `awsS3` or `azureBlobStorage`. If not set, generated site will not be published.   | `false`  |                |\n| `storage-name`          | In case of AWS, use the bucket name. In case of Azure, use container name.         | `false`  |                |\n| `aws-region`            | **Required if `publisher-type: awsS3`** - AWS Region                               | `false`  | `eu-central-1` |\n| `aws-access-key-id`     | **Required if `publisher-type: awsS3`** - AWS Access Key ID                        | `false`  |                |\n| `aws-secret-access-key` | **Required if `publisher-type: awsS3`** - AWS Secret Access Key                    | `false`  |                |\n| `azure-account-name`    | **Required if `publisher-type: azureBlobStorage`** - Azure Account Name            | `false`  |                |\n| `azure-account-key`     | **Required if `publisher-type: azureBlobStorage`** - Azure Account Key             | `false`  |                |\n| `additional-plugins`    | Space separated list of additional python plugins (Bash quoting for special chars) | `false`  |                |\n| `skip-publish`          | Indicates whether publish step should be skipped                                   | `false`  | `false`        |\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## License\n\nThis project is licensed under the Apache-2.0 License - see the [LICENSE.md](LICENSE) file for details.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"assets/staffbase.png\" alt=\"Staffbase GmbH\" width=\"96\" /\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cb\u003eStaffbase GmbH\u003c/b\u003e\n      \u003cbr /\u003eStaffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: \u003ca href=\"https://jobs.staffbase.com\" target=\"_blank\" rel=\"noreferrer\"\u003ejobs.staffbase.com\u003c/a\u003e\n      \u003cbr /\u003e\u003ca href=\"https://github.com/Staffbase\" target=\"_blank\" rel=\"noreferrer\"\u003eGitHub\u003c/a\u003e | \u003ca href=\"https://staffbase.com/\" target=\"_blank\" rel=\"noreferrer\"\u003eWebsite\u003c/a\u003e | \u003ca href=\"https://jobs.staffbase.com\" target=\"_blank\" rel=\"noreferrer\"\u003eJobs\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstaffbase%2Fbackstage-techdocs-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstaffbase%2Fbackstage-techdocs-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstaffbase%2Fbackstage-techdocs-action/lists"}