josa42/bw-actions

A collection of Github Actions

bw-actions

A collection of reusable Github Actions, for you to use in your projects.

Actions

Deploy Techdocs

The deploy-techdocs action will build your techdocs and push them to an aws-S3 bucket.

    steps:
      - uses: BrandwatchLtd/bw-actions/deploy-techdocs@main
        with:
          entity: <your-service-name>
          working-directory: <working-directory>
          TECHDOCS_S3_BUCKET_NAME: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
          AWS_TECHDOCS_ACCESS_KEY_ID: ${{ secrets.AWS_TECHDOCS_ACCESS_KEY_ID }}
          AWS_TECHDOCS_SECRET_ACCESS_KEY: ${{ secrets.AWS_TECHDOCS_SECRET_ACCESS_KEY }}
          AWS_TECHDOCS_REGION: ${{ secrets.AWS_TECHDOCS_REGION }}

your-service-name is the name of the backstage service you want to build a doc for.

working-directory lets you optionally set the working directoy where to run the command in. The default is the repo root.

Here is an example of workflow using techdocs.