Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,30 @@ on:
push:
tags:
- "v*"
workflow_dispatch:
inputs:
tag:
description: "Tag to deploy docs for (e.g. v0.1.0)"
required: true

permissions:
contents: write

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:
Expand All @@ -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 }}"}'
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Loading