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

Update deprecation and removal policy and add documentation for upstream.yaml Deprecated field #1062

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,6 @@ for inclusion in Rancher Partner charts. The Helm chart must:
Testing these requirements will ensure that Rancher users can deploy your
software correctly and easily.

### Removal

Charts will be removed from this repo if technical requirements are not met, if
a serious security problem arises, or if the vendor's SUSE "Ready" partnership
is no longer active. In these cases, the pull request that removes the chart
will indicate an alternative source (e.g. the corresponding upstream project or
[Rancher Prime Application Collection](https://apps.rancher.io)) if one is
available.

## Workflow

#### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository, clone your fork, checkout the **main-source** branch and pull the latest changes.
Expand Down Expand Up @@ -197,6 +188,7 @@ Options for `upstream.yaml`
| ArtifactHubRepo | ArtifactHubPackage | Defines the repo to access on Artifact Hub
| AutoInstall | | Allows setting a required additional chart to deploy prior to current chart, such as a dedicated CRDs chart
| ChartMetadata | | Allows setting/overriding the value of any valid [Chart.yaml variable](https://helm.sh/docs/topics/charts/#the-chartyaml-file)
| Deprecated | | Whether the package is deprecated. Deprecated packages will not integrate any new chart versions from upstream
| DisplayName | | Sets the name the chart will be listed under in the Rancher UI
| Experimental | | Adds the 'experimental' annotation which adds a flag on the UI entry
| Fetch | HelmChart, HelmRepo | Selects set of charts to pull from upstream.<br />- **latest** will pull only the latest chart version *default*<br />- **newer** will pull all newer versions than currently stored<br />- **all** will pull all versions
Expand Down Expand Up @@ -336,3 +328,18 @@ git commit -m "Migrating <vendor> <chart> chart"
git push origin <your branch>
```
#### 11. Open a pull request to the `main-source` branch for review

## Deprecation and Removal Policy

Charts may be removed from this repository for a number of reasons:

- Technical requirements are not met
- A serious security problem is discovered
- The vendor's SUSE "Ready" partnership is no longer active

In these cases, the chart will first be deprecated. While a chart is deprecated,
no new versions of the chart will be added to this repository. The chart will

Choose a reason for hiding this comment

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

Suggested change
no new versions of the chart will be added to this repository. The chart will
no new versions will be added to this repository. The chart will

be left in the deprecated state for a minimum of 3 months, and then it will be
removed. The pull requests that deprecate and remove the chart will indicate an
alternative source (e.g. the corresponding upstream project or [Rancher Prime
Application Collection](https://apps.rancher.io)) if one is available.
Comment on lines +343 to +345

Choose a reason for hiding this comment

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

Suggested change
removed. The pull requests that deprecate and remove the chart will indicate an
alternative source (e.g. the corresponding upstream project or [Rancher Prime
Application Collection](https://apps.rancher.io)) if one is available.
removed. If one is available, the pull requests that deprecate and remove the chart will indicate an
alternative source (e.g. the corresponding upstream project or [Rancher Prime
Application Collection](https://apps.rancher.io)).

Loading