Skip to content

fix: Type error in docs creation - #10069

Merged
mtrezza merged 2 commits into
parse-community:alphafrom
mtrezza:fix/docs
Feb 21, 2026
Merged

mtrezza merged 2 commits into
parse-community:alphafrom
mtrezza:fix/docs

Conversation

@mtrezza

@mtrezza mtrezza commented Feb 21, 2026 •

Copy link
Copy Markdown
Member

Pull Request

Issue

Type error in docs creation.

  • Add docs dry-run to CI to detect this issue early next time
  • Fix type ref in JSDoc

Summary by CodeRabbit

  • Chores

    • Extended the continuous integration pipeline with automatic documentation generation during builds.
  • Documentation

    • Updated type annotation documentation to improve clarity and consistency.

@parse-github-assistant

parse-github-assistant Bot commented Feb 21, 2026 •

Copy link
Copy Markdown

🚀 Thanks for opening this pull request!

@parseplatformorg

parseplatformorg commented Feb 21, 2026 •

Copy link
Copy Markdown
Contributor

✅ Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai

coderabbitai Bot commented Feb 21, 2026 •

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request adds a new CI documentation generation job to the GitHub Actions workflow and updates a JSDoc type annotation in the FilesAdapter to use a simplified import reference.

Changes

Cohort / File(s) Summary
CI Documentation Job
.github/workflows/ci.yml
Adds a new "Docs" job to the CI pipeline that installs dependencies, builds the source, and generates documentation via npm scripts using the existing node-version matrix configuration.
Type Annotation Update
src/Adapters/Files/FilesAdapter.js
Updates JSDoc annotation for the createFile method's data parameter from Buffer|import('stream').Readable to Buffer|Readable for simplified documentation reference.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mtrezza
mtrezza merged commit 02a277f into parse-community:alpha Feb 21, 2026
20 of 22 checks passed
parseplatformorg pushed a commit that referenced this pull request Feb 21, 2026
## [9.3.1-alpha.1](9.3.0...9.3.1-alpha.1) (2026-02-21)

### Bug Fixes

* Type error in docs creation ([#10069](#10069)) ([02a277f](02a277f))
@parseplatformorg

Copy link
Copy Markdown
Contributor

🎉 This change has been released in version 9.3.1-alpha.1

@parseplatformorg parseplatformorg added the state:released-alpha Released as alpha version label Feb 21, 2026
@codecov

codecov Bot commented Feb 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.60%. Comparing base (f0feb48) to head (17fe1cc).
⚠️ Report is 15 commits behind head on alpha.

Additional details and impacted files
@@           Coverage Diff           @@
##            alpha   #10069   +/-   ##
=======================================
  Coverage   92.60%   92.60%           
=======================================
  Files         191      191           
  Lines       15749    15749           
  Branches      176      176           
=======================================
  Hits        14585    14585           
  Misses       1152     1152           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mtrezza
mtrezza deleted the fix/docs branch February 21, 2026 16:27
parseplatformorg pushed a commit that referenced this pull request Feb 25, 2026
## [9.3.1](9.3.0...9.3.1) (2026-02-25)

### Bug Fixes

* GraphQL introspection disabled in `NODE_ENV=production` even with master key ([#10071](#10071)) ([a5269f0](a5269f0))
* JWT Algorithm Confusion in Google Auth Adapter ([GHSA-4q3h-vp4r-prv2](GHSA-4q3h-vp4r-prv2)) ([#10072](#10072)) ([9d5942d](9d5942d))
* Remove obsolete Parse Server option `pages.enableRouter` ([#10070](#10070)) ([00b3b72](00b3b72))
* Type error in docs creation ([#10069](#10069)) ([02a277f](02a277f))
@parseplatformorg

Copy link
Copy Markdown
Contributor

🎉 This change has been released in version 9.3.1

@parseplatformorg parseplatformorg added the state:released Released as stable version label Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

state:released Released as stable version state:released-alpha Released as alpha version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants