-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
docs: change process for generating docblocks through actions #6237
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think this is great @shahednasser, let's give it a shot!
This PR changes the original process of generating docblocks through actions. The process now is:
changeset-release/develop
, the docblock generator tool us used to generate docblocks for the changed files. The changed files are determined by retrieving all comments since the last release and the files in each of those commits.chore/generate-tsdocs
.chore/generate-tsdocs
is merged, it triggers an action that generates the references for the docs. This changes the previous behaviour of generating references on a new release.Both actions (that runs the docblock generator tool and that generates references for the docs) can also be triggered manually.