docs: Document generate-secrets.ts

[akamabu]

Documents apps/api/v2/scripts/generate-secrets.ts module purpose and public usage context

[github-actions]

Welcome to Cal.diy, @akamabu! Thanks for opening this pull request.

A few things to keep in mind:

• This is Cal.diy, not Cal.com. Cal.diy is a community-driven, fully open-source fork of Cal.com licensed under MIT. Your changes here will be part of Cal.diy — they will not be deployed to the Cal.com production app.
• Please review our Contributing Guidelines if you haven't already.
• Make sure your PR title follows the Conventional Commits format.

A maintainer will review your PR soon. Thanks for contributing!

[github-actions]

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "Docs" found in pull request title "Docs: Document generate-secrets.ts". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

[coderabbitai]

📝 Walkthrough

Walkthrough

A module-level documentation comment was added at the top of apps/api/v2/scripts/generate-secrets.ts to document the script's purpose and usage context. The script's functional behavior for generating and writing secrets remains unchanged. This is a documentation-only change with no alterations to the exported or public entities.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description directly relates to the changeset, explaining that a module comment was added to document the script's purpose and usage.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly and accurately summarizes the main change: adding documentation to the generate-secrets.ts module.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/api/v2/scripts/generate-secrets.ts`:
- Line 1: Replace the current top-of-file module comment in generate-secrets.ts
with a short intent-focused note explaining why and when to run the script
(e.g., "generate temporary secrets for local/dev bootstrap"), what it produces
(e.g., output file like .env or secrets.json for local testing), and a
sensitivity warning (secrets are not for production and should not be
committed); update the module header comment only (top of generate-secrets.ts)
to convey intent/operational context rather than restating that it "documents"
the module.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5e5dc5e1-85bb-48ec-bfed-4e7c22b78921

📥 Commits

Reviewing files that changed from the base of the PR and between fb01494 and 544bdd2.

📒 Files selected for processing (1)

• apps/api/v2/scripts/generate-secrets.ts

[coderabbitai]

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Make the module doc explain intent and operational context, not that it is documentation.

Line 1 currently states that it “documents” the module, but it doesn’t capture why this script exists or when to run it. Replace it with a brief intent-focused note (e.g., local/dev bootstrap only, output file purpose, and sensitivity warning).

Suggested rewrite

-/** Documents apps/api/v2/scripts/generate-secrets.ts module purpose and public usage context */
+/**
+ * Generates a plaintext + hashed secret pair for local development/bootstrap workflows.
+ * Writes both values to `.generated-secrets` so operators can copy them into env/config.
+ * Do not commit this output file.
+ */

As per coding guidelines, "Only add code comments that explain why, not what" and "Never add comments that simply restate what the code does."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	/** Documents apps/api/v2/scripts/generate-secrets.ts module purpose and public usage context */
	/**
	* Generates a plaintext + hashed secret pair for local development/bootstrap workflows.
	* Writes both values to `.generated-secrets` so operators can copy them into env/config.
	* Do not commit this output file.
	*/

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/api/v2/scripts/generate-secrets.ts` at line 1, Replace the current
top-of-file module comment in generate-secrets.ts with a short intent-focused
note explaining why and when to run the script (e.g., "generate temporary
secrets for local/dev bootstrap"), what it produces (e.g., output file like .env
or secrets.json for local testing), and a sensitivity warning (secrets are not
for production and should not be committed); update the module header comment
only (top of generate-secrets.ts) to convey intent/operational context rather
than restating that it "documents" the module.