Skip to content
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

House keeping #64

Merged
merged 2 commits into from
Jan 13, 2025
Merged

House keeping #64

merged 2 commits into from
Jan 13, 2025

Conversation

infeo
Copy link
Member

@infeo infeo commented Jan 10, 2025

This PR changes two minor things in the project:

  • do not hardcode the fingerprint of the signing key in the project code, only in the CI
  • prevent leakage of an API key into server logs

@infeo infeo requested a review from overheadhunter January 10, 2025 16:37
@infeo infeo self-assigned this Jan 10, 2025
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces changes to three files: two GitHub Actions workflow files and the project's pom.xml. In the workflow files for publishing to Maven Central and GitHub Packages, a new environment variable MAVEN_GPG_KEY_FINGERPRINT is added, sourced from vars.RELEASES_GPG_KEY_FINGERPRINT.

In the pom.xml, modifications are made to the dependency-check-maven plugin configuration, replacing the direct nvdApiKey with nvdApiKeyEnvironmentVariable. The keyFingerprint element is also removed from the maven-gpg-plugin configuration. These changes appear to adjust how sensitive information like API keys and GPG key identification are handled during the build and deployment processes.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/publish-central.yml (1)

35-35: Good security practice: Using GitHub variables for GPG key fingerprint

The GPG key fingerprint is now properly managed through GitHub variables instead of being hardcoded in the pom.xml.

However, there's a minor formatting issue: add a newline at the end of the file.

           MAVEN_GPG_KEY_FINGERPRINT: ${{ vars.RELEASES_GPG_KEY_FINGERPRINT }}
+
🧰 Tools
🪛 yamllint (1.35.1)

[error] 35-35: no new line character at the end of file

(new-line-at-end-of-file)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6878189 and 4af0849.

📒 Files selected for processing (3)
  • .github/workflows/publish-central.yml (1 hunks)
  • .github/workflows/publish-github.yml (1 hunks)
  • pom.xml (1 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/publish-central.yml

[error] 35-35: no new line character at the end of file

(new-line-at-end-of-file)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyse
  • GitHub Check: Build and Test
🔇 Additional comments (3)
pom.xml (2)

266-266: Good security practice: Using environment variable for NVD API key

This change prevents the API key from being exposed in logs or configuration files by using an environment variable instead of direct value.


Line range hint 315-332: Verify GPG signing configuration

The hardcoded key fingerprint has been removed from the maven-gpg-plugin configuration. Ensure that the MAVEN_GPG_KEY_FINGERPRINT environment variable is properly set in both GitHub workflows.

Run this script to verify the GPG plugin configuration:

✅ Verification successful

GPG signing configuration verified successfully

The MAVEN_GPG_KEY_FINGERPRINT environment variable is properly configured in both the GitHub Packages and Maven Central publishing workflows, sourced from vars.RELEASES_GPG_KEY_FINGERPRINT.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify GPG plugin configuration and environment variables

# Check if both workflows have the required environment variable
echo "Checking GPG environment variables in workflows..."
rg -l "MAVEN_GPG_KEY_FINGERPRINT: \${{ vars.RELEASES_GPG_KEY_FINGERPRINT }}" .github/workflows/

Length of output: 386


Script:

#!/bin/bash
# Search for GPG-related environment variables with escaped special characters
echo "Checking workflow files for GPG configuration..."
rg "MAVEN_GPG|RELEASES_GPG" .github/workflows/

# List and show content of workflow files
echo -e "\nListing workflow files:"
fd . .github/workflows/ -e yml -e yaml --exec cat {}

Length of output: 7633

.github/workflows/publish-github.yml (1)

26-26: Good practice: Consistent configuration across workflows

The GPG key fingerprint configuration is consistently implemented across both deployment workflows using GitHub variables.

Copy link
Member

@overheadhunter overheadhunter left a comment

Choose a reason for hiding this comment

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

The fingerprint is used intentionally, so the right key is used if there are multiple.

Does the added env var serve the same purpose? In that case I am fine with the change.

@infeo
Copy link
Member Author

infeo commented Jan 13, 2025

Does the added env var serve the same purpose

Yes

@infeo infeo requested a review from overheadhunter January 13, 2025 09:12
@infeo infeo merged commit 3c91805 into develop Jan 13, 2025
7 checks passed
@infeo infeo deleted the feature/house-keeping branch January 13, 2025 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants