Skip to content
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.

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

V5 Docs - GitHub Action Changes #408

Merged
merged 1 commit into from
Apr 23, 2024
Merged

V5 Docs - GitHub Action Changes #408

merged 1 commit into from
Apr 23, 2024

Conversation

colincasey
Copy link
Contributor

This builds on top of #384 to add CI checks that validate and fail the build if:

  • Code changes from the PR would alter the public API in any way
  • Generated docs are not committed

If either of the above fails, it means the whoever opened the PR needs to execute npm run api:dev to rebuild the API report + generated docs and commit them with the PR. This is beneficial since we'll see when changes will affect the public API or documentation.

@colincasey colincasey self-assigned this Apr 11, 2024
@colincasey colincasey mentioned this pull request Apr 11, 2024
Copy link
Member

@awaterma awaterma left a comment

Choose a reason for hiding this comment

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

Approved

@colincasey colincasey merged commit 45563dd into v5-docs Apr 23, 2024
8 checks passed
@colincasey colincasey deleted the v5-docs-ci branch April 23, 2024 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants