diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..89a5f0f --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,25 @@ +name: Typedoc build and deploy doc to GH pages +on: + push: + branches: ["doc"] + + workflow_dispatch: + +permissions: + contents: write +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Install and Build + run: | + npm ci + npm run doc + + - name: Deploy + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: dist/docs diff --git a/README.md b/README.md index 7765239..50b11e0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,9 @@ This [cdk](https://github.com/aws/aws-cdk) IaC library help you to deploy AWS cl ### Quickstart Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo. +### API documentation +[API documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci/) generated by `npm run doc` + ### Development Setup You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a local copy of this repo.