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

docs: change process for generating docblocks through actions #6237

Merged
merged 10 commits into from
Jan 29, 2024

Conversation

shahednasser
Copy link
Member

This PR changes the original process of generating docblocks through actions. The process now is:

  1. When a PR is merged for the branch 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.
  2. If there are changes after using the docblock generator tool, a PR is opened in the branch chore/generate-tsdocs.
  3. Once the 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.

@shahednasser shahednasser requested review from a team as code owners January 26, 2024 20:02
Copy link

changeset-bot bot commented Jan 26, 2024

⚠️ No Changeset found

Latest commit: b1be00f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-reference ✅ Ready (Inspect) Visit Preview Jan 29, 2024 7:55am
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2024 7:55am
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2024 7:55am
medusa-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2024 7:55am

Copy link
Contributor

@olivermrbl olivermrbl left a 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants