Skip to content

Conversation

insider89
Copy link
Contributor

@insider89 insider89 commented Mar 26, 2025

Summary by Sourcery

Documentation:

  • Update documentation to consistently use 'GCP Secret Manager' terminology across all sections, including headings, tab labels, and configuration examples

Copy link

sourcery-ai bot commented Mar 26, 2025

Reviewer's Guide by Sourcery

This pull request renames all instances of 'Google Secret Manager' to 'GCP Secret Manager' within the documentation. This change aims to align the documentation with the current naming conventions and terminology used by Google Cloud Platform.

Class diagram for Helm Chart Values

classDiagram
    class HelmValues {
        gcpSecretManager: GCPSecretManager
        awsSecretManager: AWSSecretManager
        vault: Vault
    }
    class GCPSecretManager {
        enabled: boolean
        projectId: string
        credentials: string
    }
    class AWSSecretManager {
        enabled: boolean
        region: string
        accessKeyId: string
        secretAccessKey: string
    }
    class Vault {
        enabled: boolean
        address: string
        token: string
    }
    HelmValues -- GCPSecretManager : has
    HelmValues -- AWSSecretManager : has
    HelmValues -- Vault : has
    note for GCPSecretManager "Configuration for GCP Secret Manager"
    note for AWSSecretManager "Configuration for AWS Secret Manager"
    note for Vault "Configuration for HashiCorp Vault"
Loading

File-Level Changes

Change Details Files
Renamed 'Google Secret Manager' to 'GCP Secret Manager' in the documentation.
  • Updated the platform options list.
  • Updated the tabs for deployment options.
  • Updated the callout text.
  • Updated the Helm chart values.
  • Updated the validation section.
  • Updated the issues section.
content/docs/launching-the-platform/self-hosted-onprem/prerequisites/secret-management.mdx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the fix Bug fix label Mar 26, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @insider89 - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Hardcoded GCP credentials found. (link)

Overall Comments:

  • This change looks good, but could you also update the code to use gcpSecretManager instead of googleSecretManager?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🔴 Security: 1 blocking issue
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -260,7 +260,7 @@ vault:
enabled: false
awsSecretManager:
enabled: false
googleSecretManager:
gcpSecretManager:
enabled: true
projectId: "your-project-id"
credentials: |
Copy link

Choose a reason for hiding this comment

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

🚨 issue (security): Hardcoded GCP credentials found.

The credentials field contains what appears to be a hardcoded service account JSON key. This should be fetched from a secure source, such as a file or environment variable, rather than being hardcoded in the configuration.

@insider89 insider89 merged commit c777f26 into main Mar 27, 2025
3 checks passed
@insider89 insider89 deleted the fix/google-to-gcp branch March 27, 2025 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix Bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant