Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
# api/) isn't buried under noisy regenerated MDX/JSON.
docs/bitrise-api/api-reference/** linguist-generated=true
docs/bitrise-rde-api/api-reference/** linguist-generated=true
docs/release-management-api/**/api-reference/** linguist-generated=true
49 changes: 43 additions & 6 deletions .github/workflows/sync-api-references.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
name: Sync API references

# Keeps the generated API references (Bitrise CI + RDE) in sync with their
# hosted OpenAPI specs. Runs nightly and on demand ("Run workflow"). For each
# spec, when the hosted spec has actually changed, it regenerates that one
# reference and opens a PR for review — it never commits to main directly.
# Keeps the generated API references (Bitrise CI, RDE, and the four Release
# Management sub-APIs) in sync with their hosted OpenAPI specs. Runs nightly
# and on demand ("Run workflow"). For each spec, when the hosted spec has
# actually changed, it regenerates that one reference and opens a PR for
# review — it never commits to main directly.
#
# Each spec runs as its own matrix job → its own PR, so the two products stay
# Each spec runs as its own matrix job → its own PR, so the products stay
# independent (separate review, separate branches, one host being down doesn't
# block the other).
# block the others).
on:
schedule:
- cron: '0 6 * * *' # 06:00 UTC daily
Expand Down Expand Up @@ -46,6 +47,42 @@ jobs:
api/bitrise-rde.json
scripts/rde_spec_sync_state.json
docs/bitrise-rde-api/api-reference
- name: Release Management Apps
spec: bitriseRMApps
sync_script: scripts/sync_rm_apps_spec.py
branch: auto/rm-apps-api-sync
title: 'docs: sync Release Management Apps API reference from updated spec'
paths: |
api/bitrise-rm-apps.json
scripts/rm_apps_spec_sync_state.json
docs/release-management-api/apps/api-reference
- name: Release Management Store Releases
spec: bitriseRMStoreReleases
sync_script: scripts/sync_rm_store_releases_spec.py
branch: auto/rm-store-releases-api-sync
title: 'docs: sync Release Management Store Releases API reference from updated spec'
paths: |
api/bitrise-rm-store-releases.json
scripts/rm_store_releases_spec_sync_state.json
docs/release-management-api/store-releases/api-reference
- name: Release Management Code Push
spec: bitriseRMCodePush
sync_script: scripts/sync_rm_code_push_spec.py
branch: auto/rm-code-push-api-sync
title: 'docs: sync Release Management Code Push API reference from updated spec'
paths: |
api/bitrise-rm-code-push.json
scripts/rm_code_push_spec_sync_state.json
docs/release-management-api/code-push/api-reference
- name: Release Management Build Distributions
spec: bitriseRMBuildDistributions
sync_script: scripts/sync_rm_build_distributions_spec.py
branch: auto/rm-build-distributions-api-sync
title: 'docs: sync Release Management Build Distributions API reference from updated spec'
paths: |
api/bitrise-rm-build-distributions.json
scripts/rm_build_distributions_spec_sync_state.json
docs/release-management-api/build-distributions/api-reference
steps:
- uses: actions/checkout@v4

Expand Down
1 change: 1 addition & 0 deletions api/bitrise-rm-apps.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions api/bitrise-rm-build-distributions.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions api/bitrise-rm-code-push.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions api/bitrise-rm-store-releases.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/bitrise-api/api-reference/app-config-create.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/bitrise-api/api-reference/app-delete.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/bitrise-api/api-reference/app-notifications.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions docs/bitrise-api/api-reference/app-roles-query.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/bitrise-api/api-reference/app-roles-update.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/bitrise-api/api-reference/app-update.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/bitrise-api/api-reference/cache-item-delete.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/bitrise-api/api-reference/cache-item-download.api.mdx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading