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.
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(contributing) add a guide on adding js packages #2629
docs(contributing) add a guide on adding js packages #2629
Changes from 1 commit
c133d21
1bfacdc
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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.
TODO: Automate documentation regeneration in CI.
Would you like assistance in setting up a GitHub Action to automate the regeneration of API docs as mentioned in the TODO?
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.
sure
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.
@trajan0x, great! Here's a draft for a GitHub Action that automates the regeneration of API docs whenever changes are made to the
docs
directory. You can add this job to your existing.github/workflows/lerna.yaml
file:This configuration adds a new job
regenerate-api-docs
that depends on thebuild
job. It ensures that the API documentation is regenerated only after a successful build. Theregenerate-api-docs
job sets up the environment, installs dependencies, and runs the command to regenerate the API docs.You can add this job to your workflow file by appending it under the
jobs
section. Let me know if you need any more help with this setup!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.
Consider adding a period at the end of the command line for clarity.
Committable suggestion