Skip to content

Automating the doc schema generation using husky. #2851

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.

Sign up for GitHub

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

Closed
wants to merge 14 commits into from
Closed

Automating the doc schema generation using husky. #2851

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9ccdecd
Adding generate schema script in husky
Suyash878 Jan 13, 2025
704cca4
fixing package.json and package-lock.json
Suyash878 Jan 13, 2025
20efc77
test commit
Suyash878 Jan 19, 2025
033db80
updating package.json and package-lock.json
Suyash878 Jan 19, 2025
b30e9f4
syncing package.json and package-lock.json
Suyash878 Jan 20, 2025
ab75bf4
test commit
Suyash878 Jan 22, 2025
a6690d0
Adding schema-eneration.yml
Suyash878 Jan 22, 2025
fc2bc5e
Adding schema-generator.mjs
Suyash878 Jan 26, 2025
095e696
removing schema-generation.yml
Suyash878 Jan 26, 2025
e4413ce
Adding typedoc and generating .md files for the schema
Suyash878 Jan 27, 2025
f376d03
Adding docusaurus and sidebar.ts
Suyash878 Jan 27, 2025
b5a9d8b
Commit
Suyash878 Jan 29, 2025
cfd6882
resolving conflicts
Suyash878 Jan 29, 2025
4d55f8f
resolving errors
Suyash878 Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions .husky/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@
[ -n "$CI" ] && exit 0

# Change to the current directory
npm run dev &
SERVER_PID=$!

# Checks code for typescript type errors and throws errors if found.
npm run typecheck
# Wait for server to be ready (adjust sleep time as needed)
sleep 10
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove server management from pre-commit hook.

Starting a server in a pre-commit hook introduces several risks:

  • Race conditions if multiple developers commit simultaneously
  • Potential port conflicts if a server is already running
  • Unreliable sleep-based timing
  • Resource overhead for every commit

Based on the PR discussion with @palisadoes, this should be moved to a CI/CD workflow instead.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized file modification or deletion attempt


# Formats staged code using prettier
# Checks and fixes all lint issues in code which don't require manual intervention.
# Throws errors if lint issues requiring manual intervention are found in code.
# Run your commands
npm run format:fix
# npm run lint:fix
npm run lint-staged

npm run gen:schema

# Generate table of contents for markdown files in root directory
npm run typecheck
npm run update:toc
npm run generate:graphql-markdown
npm run generate:graphql-schema

# Kill the background server process
kill $SERVER_PID
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove server cleanup code.

The server cleanup is tightly coupled with the server startup, which should be removed from the pre-commit hook.

If the server fails to start or the script exits prematurely, this could kill unrelated processes or leave orphaned processes.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized file modification or deletion attempt


# Add the changes made to the stage
git add .
Loading
Loading