diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5018e07..60e8fc7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,6 +4,11 @@ on: push: tags: - "v*" + workflow_dispatch: + inputs: + tag: + description: "Tag to deploy docs for (e.g. v0.1.0)" + required: true permissions: contents: write @@ -11,15 +16,18 @@ permissions: jobs: lint: name: Lint + if: github.event_name == 'push' uses: ./.github/workflows/lint.yml bundle: name: Bundle + if: github.event_name == 'push' needs: lint uses: ./.github/workflows/bundle.yml release: name: Create Release + if: github.event_name == 'push' needs: bundle runs-on: ubuntu-latest steps: @@ -37,3 +45,17 @@ jobs: ## 📦 OpenAPI Specification Download the bundled OpenAPI spec: `openapi.yml` + + deploy-pages: + name: Dispatch Docs Deploy + needs: release + if: always() && (needs.release.result == 'success' || needs.release.result == 'skipped') + runs-on: ubuntu-latest + steps: + - name: Trigger docs repo build + uses: peter-evans/repository-dispatch@v3 + with: + token: ${{ secrets.DOCS_DEPLOY_TOKEN }} + repository: ${{ github.repository_owner }}/muEd-api-docs + event-type: trigger-build + client-payload: '{"tag": "${{ inputs.tag || github.ref_name }}", "repo": "${{ github.repository }}"}' diff --git a/README.md b/README.md index b6380ff..ca2db84 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # µEd API (µEd-api) -Educational Microservices API **specification**. +Education Microservices API **specification**. This repository is intentionally **spec-only**. It defines an **OpenAPI 3.1** contract that educational services can implement to conform to the µEd API.