Automatically update Facade docblocks #538
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new workflow that will automatically keep the
Inertia\Inertiafacade's docblock up to date with the underlying implementation.This workflow only targets the
masterbranch and will automatically commit changes back intomasterwhen a PR is merged - so it won't interrupt PRs from the community.Note that the script reads the types from the underlying implementation, so if there are mistakes in those types they should be corrected in the implementation rather than on the Facade.
If you run into any issues with the generator - let me know.
We already use this workflow on
laravel/framework,laravel/pennant, and some other packages.