Skip to content

feat(ci): Add scheduled trigger to auto-trigger-code-samples workflow #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rwjblue-glean wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(ci): Add scheduled trigger to auto-trigger-code-samples workflow #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
950c4e0
feat(ci): Add scheduled trigger to auto-trigger-code-samples workflow
rwjblue-glean Dec 11, 2025
d7e83c3
chore(docs): Update the documentation RE: the docs deployment pipeline
rwjblue-glean Dec 11, 2025
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
4 changes: 4 additions & 0 deletions .github/workflows/auto-trigger-code-samples.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ on:
repository_dispatch:
types: [client-released]

# Run every 4 hours to check if all client releases are ready
schedule:
- cron: '0 */4 * * *'

concurrency:
group: auto-trigger-code-samples
cancel-in-progress: true
Expand Down
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,13 @@ flowchart TD

This repository uses several GitHub Actions workflows to process the OpenAPI specifications:

| Workflow | Purpose | Trigger |
| --------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `transform.yml` | Transforms source specs and runs the `glean-api-specs` Speakeasy source to generate API specs. | Push to main (source_specs changes), schedule, manual |
| `generate-code-samples.yml` | Runs Speakeasy to generate merged code samples specs. | Manual only |
| `deploy-pages.yml` | Deploys specs to GitHub Pages. | After generate-code-samples completes, manual |
| Workflow | Purpose | Trigger |
| ------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `transform.yml` | Transforms source specs and runs the `glean-api-specs` Speakeasy source to generate API specs. | Push to main (source_specs changes), schedule, manual |
| `trigger-client-generation.yml` | Triggers SDK generation workflows in all 4 API client repos. | After transform.yml completes, manual |
| `auto-trigger-code-samples.yml` | Checks if all client releases are ready and triggers code sample generation. | Every 4 hours, repository_dispatch, manual |
| `generate-code-samples.yml` | Runs Speakeasy to generate merged code samples specs. | Triggered by auto-trigger-code-samples, manual |
| `deploy-pages.yml` | Deploys specs to GitHub Pages. | After generate-code-samples completes, manual |

The processing follows this sequence:

Expand Down Expand Up @@ -211,7 +213,7 @@ In order to roll out changes from the upstream original source repo all the way
- [gleanwork/api-client-typescript](https://github.com/gleanwork/api-client-typescript)
- [gleanwork/api-client-go](https://github.com/gleanwork/api-client-go)
7. 🤖CI in each of the API Client repos releases to their respective package managers
8. 👷Once all 4 API Clients are merged and released, manually trigger [generate-code-samples.yml](https://github.com/gleanwork/open-api/actions/workflows/generate-code-samples.yml) workflow
8. 🤖[auto-trigger-code-samples.yml](https://github.com/gleanwork/open-api/actions/workflows/auto-trigger-code-samples.yml) checks every 4 hours if all API Client releases match the expected SHA, and triggers [generate-code-samples.yml](https://github.com/gleanwork/open-api/actions/workflows/generate-code-samples.yml) when ready
9. 🤖CI in this repo runs the [deploy-pages.yml](https://github.com/gleanwork/open-api/actions/workflows/deploy-pages.yml) workflow to deploy the final specs to GitHub Pages
10. 🤖CI in this repo runs [trigger-developer-site-redeploy.yml](https://github.com/gleanwork/open-api/actions/workflows/trigger-developer-site-redeploy.yml)
11. 🤖CI in [gleanwork/glean-developer-site](https://github.com/gleanwork/glean-developer-site) pushes a commit to trigger deployment
Expand Down