Skip to content

docs: Update helmet.md default values #3350

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

Merged
merged 1 commit into from
Mar 14, 2025
Merged

docs: Update helmet.md default values #3350

merged 1 commit into from
Mar 14, 2025

Conversation

gaby
Copy link
Member

@gaby gaby commented Mar 13, 2025

Same as #3348 but for the middleware docs

@gaby gaby requested a review from a team as a code owner March 13, 2025 03:13
@gaby gaby requested review from sixcolors, ReneWerner87 and efectn and removed request for a team March 13, 2025 03:13
Copy link
Contributor

coderabbitai bot commented Mar 13, 2025

Walkthrough

The change updates the documentation for the Helmet middleware. Specifically, the default value of the ReferrerPolicy in the configuration table is modified from "ReferrerPolicy" to "no-referrer". This update clarifies the intended behavior regarding the handling of the Referrer header in HTTP requests.

Changes

File Change Summary
docs/middleware/helmet.md Updated the default ReferrerPolicy value in the config table from "ReferrerPolicy" to "no-referrer"

Possibly related PRs

Suggested reviewers

  • sixcolors
  • efectn
  • ReneWerner87

Poem

I'm a little rabbit on the run,
Hoping these changes bring some fun.
No referrer now, clear as day,
Guiding headers on their way.
Carrots and code in a perfect blend 🥕🐇.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef4437c and 969af3b.

📒 Files selected for processing (1)
  • docs/middleware/helmet.md (1 hunks)
🔇 Additional comments (2)
docs/middleware/helmet.md (2)

57-57: Updated Default Value for ReferrerPolicy in Config Table

The configuration table now correctly shows "no-referrer" as the default value, reflecting the intended behavior of not sending referrer information. This update is clear and aligns with the documentation’s purpose.


74-74: Consistent Update in Default Config Code

The default configuration within the Go code snippet has been updated to "no-referrer" for the ReferrerPolicy property. This change mirrors the update in the configuration table and maintains consistency across the documentation.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ReneWerner87 ReneWerner87 merged commit b56a141 into main Mar 14, 2025
3 checks passed
@gaby gaby deleted the helmet-docs branch June 18, 2025 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants