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

IN-4297 CI Script for Magento GraphQL Queries Documentation #1543

Merged
merged 2 commits into from
Sep 29, 2024
Merged

Conversation

Olbix
Copy link
Contributor

@Olbix Olbix commented Sep 25, 2024

No description provided.

@Olbix Olbix requested a review from a team as a code owner September 25, 2024 13:14
Copy link

changeset-bot bot commented Sep 25, 2024

⚠️ No Changeset found

Latest commit: 04976c1

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

@Olbix
Copy link
Contributor Author

Olbix commented Sep 26, 2024

To run the script in the main package.json, execute the following command:

yarn graphQlApiDocs:md
The documentation will then be generated in the file located at:
/docs/content/5.api/magento-graphql-queries.md

In general, the script should be run during the CI process at the changesets:version step.

generated md:
Screenshot 2024-09-26 at 11 22 46

@Olbix Olbix merged commit c86a202 into main Sep 29, 2024
7 checks passed
@Olbix Olbix deleted the feat/IN-4297 branch September 29, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants