https://github.com/gocardless/publish-techdocs-action
Action to generate and publish TechDocs
https://github.com/gocardless/publish-techdocs-action
Last synced: about 1 month ago
JSON representation
Action to generate and publish TechDocs
- Host: GitHub
- URL: https://github.com/gocardless/publish-techdocs-action
- Owner: gocardless
- License: apache-2.0
- Created: 2021-05-20T08:05:21.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-27T09:39:20.000Z (almost 2 years ago)
- Last Synced: 2026-05-28T14:29:14.023Z (about 1 month ago)
- Language: Shell
- Size: 25.4 KB
- Stars: 1
- Watchers: 8
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Generate and Publish TechDocs to GCS
**EXPERIMENTAL: Use at own risk**
> [GitHub Action](https://github.com/features/actions) for [Publishing TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)
[![GitHub Release][release-img]][release]
[![GitHub Marketplace][marketplace-img]][marketplace]
[![License][license-img]][license]
## Table of Contents
- [Usage](#usage)
- [Workflow](#workflow)
## Usage
### Workflow
```yaml
name: publish-techdocs
on:
push:
branches:
- master
paths:
- docs/**
jobs:
publish-techdocs:
name: Publish Techdocs
runs-on: ubuntu-latest
strategy:
matrix:
n:
- env: staging
secret: TECHDOCS_GCS_SECRET_ACCESS_KEY_STAGING
- env: production
secret: TECHDOCS_GCS_SECRET_ACCESS_KEY_PRODUCTION
steps:
- uses: actions/checkout@v3
- name: Publish TechDocs - ${{ matrix.n.env }}
uses: gocardless/publish-techdocs-action@master
with:
publisher: googleGcs
credentials: ${{ secrets[matrix.n.secret] }}
bucket: gc-prd-tech-docs-${{ matrix.n.env }}
entity: default/component/
```
[release]: https://github.com/gocardless/publish-techdocs-action/releases/latest
[release-img]: https://img.shields.io/github/release/gocardless/publish-techdocs-action?include_prereleases&color=blue
[marketplace]: https://github.com/marketplace/actions/publish-techdocs
[marketplace-img]: https://img.shields.io/badge/marketplace-publish--techdocs-blue?logo=github
[license]: https://github.com/gocardless/publish-techdocs-action/blob/master/LICENSE
[license-img]: https://img.shields.io/github/license/gocardless/publish-techdocs-action