📝 Add docstrings to feature/github-action-package

[coderabbitai]

Docstrings generation was requested by @srod.

• feat(action): add @node-minify/action GitHub Action package for Marketplace #2760 (comment)

The following files were modified:

• packages/action/src/checks.ts
• packages/action/src/index.ts
• packages/action/src/inputs.ts
• packages/action/src/minify.ts
• packages/action/src/outputs.ts
• packages/action/src/reporters/annotations.ts
• packages/action/src/reporters/comment.ts
• packages/action/src/reporters/summary.ts
• packages/benchmark/src/runner.ts
• packages/utils/src/getFilesizeGzippedInBytes.ts
• scripts/check-published.ts

These files were ignored

• packages/action/__tests__/action.test.ts
• packages/utils/__tests__/utils.test.ts

These file types are not supported

• .github/actions/node-minify/README.md
• .github/actions/node-minify/action.yml
• .github/workflows/release-action.yml
• .github/workflows/test-action.yml
• AGENTS.md
• action.yml
• docs/AGENTS.md
• docs/src/content/docs/benchmark.md
• docs/src/content/docs/cli.md
• docs/src/content/docs/github-action.md
• packages/action/README.md
• packages/action/action.yml
• packages/action/package.json
• packages/action/tsconfig.json
• packages/benchmark/README.md

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

---

Summary by cubic

Added comprehensive docstrings across the GitHub Action, reporters, benchmark runner, utilities, and publishing script to clarify parameters, return values, and error cases. No runtime changes; improves readability, IDE hints, and onboarding.

^{Written for commit 2f55a56. Summary will update on new commits.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2f55a56

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

[coderabbitai]

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

[greptile-apps]

PR author is in the excluded authors list.

[cubic-dev-ai]

No issues found across 11 files

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.55%. Comparing base (98c3771) to head (2f55a56).
⚠️ Report is 3 commits behind head on feature/github-action-package.

Additional details and impacted files

@@                      Coverage Diff                       @@
##           feature/github-action-package    #2761   +/-   ##
==============================================================
  Coverage                          99.55%   99.55%           
==============================================================
  Files                                 59       59           
  Lines                               1117     1117           
  Branches                             337      337           
==============================================================
  Hits                                1112     1112           
  Misses                                 5        5           

☔ 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.