Skip to content

feat: Update api schema github actions #4511

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

Jump to bottom
Merged
merged 1 commit into from
May 27, 2025
Merged

feat: Update api schema github actions #4511

merged 1 commit into from
May 27, 2025

Conversation

HyeockJinKim
Copy link
Collaborator

Checklist: (if applicable)

  • Milestone metadata specifying the target backport version
  • Mention to the original issue
  • Installer updates including:
    • Fixtures for db schema changes
    • New mandatory config options
  • Update of end-to-end CLI integration tests in ai.backend.test
  • API server-client counterparts (e.g., manager API -> client SDK)
  • Test case(s) to:
    • Demonstrate the difference of before/after
    • Demonstrate the flow of abstract/conceptual models with a concrete implementation
  • Documentation
    • Contents in the docs directory
    • docstrings in public interfaces and type annotations

@HyeockJinKim HyeockJinKim requested a review from Yaminyam May 26, 2025 09:01
@HyeockJinKim HyeockJinKim self-assigned this May 26, 2025
@Copilot Copilot AI review requested due to automatic review settings May 26, 2025 09:01
@HyeockJinKim HyeockJinKim added the skip:changelog Make the action workflow to skip towncrier check label May 26, 2025
Copilot
Copilot AI reviewed May 26, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR streamlines API schema updates by removing manual documentation dumps from the release script and updating the GitHub Actions workflow to better trigger on schema-related changes.

  • Remove direct schema dump commands from release.sh
  • Rename and expand triggers in the update-api-schema.yml workflow

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
scripts/release.sh Dropped manual GraphQL/OpenAPI schema generation steps
.github/workflows/update-api-schema.yml Changed workflow name to update-api-schema and added VERSION to watched paths
Comments suppressed due to low confidence (1)

scripts/release.sh:27

  • By removing these schema dump commands from the release script, generated docs may become outdated. Consider moving schema export into the CI workflow or adding an automated step to update the GraphQL/OpenAPI docs.
./backend.ai mgr api dump-gql-schema --output docs/manager/graphql-reference/schema.graphql

@HyeockJinKim HyeockJinKim added this pull request to the merge queue May 27, 2025
Merged via the queue into main with commit 5e60412 May 27, 2025
28 of 30 checks passed
@HyeockJinKim HyeockJinKim deleted the feat/change-update-api-schema branch May 27, 2025 01:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@Yaminyam Yaminyam Yaminyam approved these changes

Assignees

@HyeockJinKim HyeockJinKim

Labels
skip:changelog Make the action workflow to skip towncrier check
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@HyeockJinKim @Yaminyam