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

Fix license and chart version #33

Merged
merged 1 commit into from
Jan 19, 2024
Merged

Fix license and chart version #33

merged 1 commit into from
Jan 19, 2024

Conversation

hoptical
Copy link
Collaborator

@hoptical hoptical commented Jan 19, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the Helm chart deployment instructions to the latest version.
    • Changed the project's license from Apache License 2.0 to GPL 3.0.

@hoptical hoptical added the documentation Improvements or additions to documentation label Jan 19, 2024
@hoptical hoptical self-assigned this Jan 19, 2024
Copy link
Contributor

coderabbitai bot commented Jan 19, 2024

Walkthrough

The project has undergone a minor version update in its Helm chart, signifying a potential enhancement or fix in the deployment process. More notably, there's a significant shift in the licensing policy, moving from the permissive Apache License 2.0 to the more restrictive GPL 3.0, which could have implications on how the software can be used and shared.

Changes

File Change Summary
README.md Updated Helm chart from v0.3.5 to v0.3.6; License changed from Apache 2.0 to GPL 3.0

🐇✨
To the tune of an update chime,
We hopped from .5 to .6 in time.
With a license swap on the stage,
Our code now dances on a different page.
🎩🥕

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@hoptical hoptical merged commit 9c465d4 into main Jan 19, 2024
3 checks passed
Copy link
Contributor

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b3c3db6 and 5179bd5.
Files selected for processing (1)
  • README.md (2 hunks)
Additional comments: 1
README.md (1)
  • 162-162: The link to the LICENSE file has been correctly updated to point to GPL 3.0.

@@ -35,7 +35,7 @@ make deploy
Deploy using Helm (version 3.8.0 or later), which supports OCI charts. To use the helm chart, edit the `values.yaml` file and set `controllerManagerConfig.configYaml` to your Ceph cluster configuration like [secret.yaml](config/manager/secret.yaml).

```bash
helm upgrade --install ceph-s3-operator oci://ghcr.io/snapp-incubator/ceph-s3-operator/helm-charts/ceph-s3-operator --version v0.3.5
helm upgrade --install ceph-s3-operator oci://ghcr.io/snapp-incubator/ceph-s3-operator/helm-charts/ceph-s3-operator --version v0.3.6
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The Helm chart's appVersion has been updated to v0.3.6 in charts/ceph-s3-operator/Chart.yaml, which corresponds with the version mentioned in the README.md. However, there is no evidence of the Helm chart's own version being updated to v0.3.6. This might indicate that the Helm chart itself may not have been updated to the new version, which could lead to inconsistencies or deployment issues. It is recommended to verify the Helm chart's version field to ensure it matches the intended release version.

Analysis chain

The Helm chart version has been updated from v0.3.5 to v0.3.6. Ensure that the Helm chart at the new version is available in the repository and that any dependent configurations or documentation have been updated accordingly.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify the Helm chart version v0.3.6 exists
rg --files-with-matches "version: v0.3.6" --glob 'charts/ceph-s3-operator/Chart.yaml'

Length of output: 85



Script:

#!/bin/bash
# Search for any Chart.yaml files in the repository
fd Chart.yaml

# Search for the string "v0.3.6" across the entire repository to check if the version is mentioned elsewhere
rg "v0.3.6"

Length of output: 348

Comment on lines 35 to 41
Deploy using Helm (version 3.8.0 or later), which supports OCI charts. To use the helm chart, edit the `values.yaml` file and set `controllerManagerConfig.configYaml` to your Ceph cluster configuration like [secret.yaml](config/manager/secret.yaml).

```bash
helm upgrade --install ceph-s3-operator oci://ghcr.io/snapp-incubator/ceph-s3-operator/helm-charts/ceph-s3-operator --version v0.3.5
helm upgrade --install ceph-s3-operator oci://ghcr.io/snapp-incubator/ceph-s3-operator/helm-charts/ceph-s3-operator --version v0.3.6
```

### Using OLM
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The license badge still indicates the old Apache License 2.0. This should be updated to reflect the change to GPL 3.0 to avoid confusion.

- ![License](https://img.shields.io/github/license/snapp-incubator/ceph-s3-operator)
+ ![License](https://img.shields.io/badge/license-GPLv3-blue.svg)

@hoptical hoptical deleted the update/readme branch March 20, 2024 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant