dfinity / sdk

IC SDK: a Software Development Kit for creating and managing canister smart contracts on the ICP blockchain.

https://internetcomputer.org/developers

Apache License 2.0

167 stars 84 forks source link

feat: require all PRs to update JSON schema if changed #3803

Closed ericswanson-dfinity closed 3 weeks ago

ericswanson-dfinity commented 3 weeks ago

Description

The update-docs workflow doesn't work (skips itself) for external PRs.

Make it fail any PR if any of the schema command outputs changed and the changes are not included in the PR, rather than pushing a commit to update them.

This way it will work on external PRs too, and we can make it a required status.

How Has This Been Tested?

The following PR makes a schema change: https://github.com/dfinity/sdk/pull/3805

Checklist:

[x] The title of this PR complies with Conventional Commits.
[ ] I have edited the CHANGELOG accordingly.
[ ] I have made corresponding changes to the documentation.