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

ds/linter/markdown #466

Closed
wants to merge 34 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
27c9be9
downstream-only: document repository maintenance
nixpanic Nov 12, 2021
945da36
ci: disable dependabot PR creation
nixpanic Jan 19, 2022
92e64c4
[DOWNSTREAM-ONLY] build: hide the CSI-Addons Operator from the UI
nixpanic Jan 20, 2022
edb16f8
[DOWNSTREAM-ONLY] build: use Red Hat icon for UI
nixpanic Apr 11, 2022
052a827
Merge pull request #41 from csi-addons/main
openshift-merge-robot May 6, 2022
44d7316
[DOWNSTREAM-ONLY]: document process for resolving conflicts
Rakshith-R May 6, 2022
5204663
Merge pull request #43 from Rakshith-R/DS-conflicts
openshift-merge-robot May 6, 2022
c51cd62
Merge pull request #46 from csi-addons/main
openshift-merge-robot May 10, 2022
1ee3c42
Merge pull request #47 from csi-addons/main
openshift-ci[bot] Jun 15, 2022
7996f7d
Merge pull request #52 from csi-addons/main
openshift-merge-robot Jul 28, 2022
a01c437
Merge pull request #53 from csi-addons/main
openshift-merge-robot Aug 30, 2022
c31c74f
[DOWNSTREAM-ONLY] remove Yug from OWNERS
nixpanic Sep 1, 2022
71b3612
Merge pull request #55 from nixpanic/ds/owner-update
openshift-merge-robot Sep 1, 2022
9392446
Merge pull request #59 from csi-addons/main
openshift-merge-robot Sep 13, 2022
8aee53c
Merge pull request #62 from csi-addons/main
openshift-merge-robot Oct 7, 2022
41b1273
[DOWNSTREAM-ONLY] ci: disable Dependabot PR creation
nixpanic Oct 7, 2022
7892d8c
Merge pull request #65 from nixpanic/ds/depandabot/disable
openshift-merge-robot Oct 7, 2022
74bc6e1
Merge pull request #66 from csi-addons/main
openshift-merge-robot Nov 3, 2022
d1d6162
Merge pull request #68 from csi-addons/main
openshift-merge-robot Nov 8, 2022
6351028
Merge pull request #72 from csi-addons/main
openshift-merge-robot Dec 16, 2022
40854f5
Merge pull request #74 from csi-addons/main
openshift-merge-robot Jan 12, 2023
c7d7b30
Merge pull request #75 from csi-addons/main
openshift-merge-robot Feb 7, 2023
a1d3660
Merge pull request #76 from csi-addons/main
openshift-merge-robot Mar 9, 2023
36ebccb
Merge pull request #78 from csi-addons/main
openshift-merge-robot Mar 28, 2023
1585d76
Merge pull request #80 from csi-addons/main
openshift-merge-robot Jun 21, 2023
a08b342
Merge pull request #81 from csi-addons/main
openshift-merge-robot Jul 6, 2023
54e342e
[DOWNSTREAM-ONLY] ci: disable Dependabot PR creation
nixpanic Jul 17, 2023
e9d3ef5
Merge pull request #83 from nixpanic/ds/depandabot/disable
openshift-merge-robot Jul 17, 2023
2e61800
cleanup: update OWNERS_ALIASES
nixpanic Oct 12, 2023
d7e5474
Merge pull request #86 from nixpanic/ds/cleanup/OWNERS
openshift-ci[bot] Oct 12, 2023
c154f46
redhat: point to the right upstream project in the README
nixpanic Oct 12, 2023
7335c98
Merge pull request #87 from nixpanic/ds/redhat/README
openshift-ci[bot] Oct 12, 2023
aed5536
Merge pull request #89 from csi-addons/main
openshift-ci[bot] Oct 12, 2023
be8f91f
[DOWNSTREAM-ONLY] cleanup: address MarkDown linter issues
nixpanic Oct 12, 2023
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
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/redhat-backport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Backport commits to a release branch

**You must EDIT ME! The contents below is an example only.**

Bug 000000 gets hit when the system is out for its birthday party. After
providing the system with sufficient cake, it returns to normal business the
next day.

I hereby confirm that:

- [ ] this change is in the upstream project (*reference?*)
- [ ] this change is in the devel branch of this project
- [ ] branches for higher versions of the project have this change merged
- [ ] this PR is not *downstream-only*, if that was the case, I would have
explained its need very clearly

7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/redhat-downstream-only.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# [DOWNSTREAM-ONLY] non-upstreamable changes

**You must EDIT ME! The contents below is an example only.**

The downstream CI testing depends on additional settings in the Search
Optimization so that the project contributors can get a piece of chocolate for
every merged PR.
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/redhat-sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Sync the upstream changes

**You must EDIT ME! The contents below is an example only.**

Sync the upstream changes from `csi-addons/kubernetes-csi-addons:main` into the
`main` branch. The most important recent changes that we want included are:

- the new foz bar baz works flawlessly
- this addresses a bug where users are facing issues with XYZ
- ...

6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
version: 2
updates:
- package-ecosystem: "gomod"
# ODF only: disable PR creation, synced from upstream
open-pull-requests-limit: 0
directory: "/"
schedule:
interval: "weekly"
Expand All @@ -11,6 +13,8 @@ updates:
labels:
- vendor
- package-ecosystem: "gomod"
# ODF only: disable PR creation, synced from upstream
open-pull-requests-limit: 0
directory: "/tools"
schedule:
interval: "weekly"
Expand All @@ -20,6 +24,8 @@ updates:
labels:
- vendor
- package-ecosystem: "github-actions"
# ODF only: disable PR creation, synced from upstream
open-pull-requests-limit: 0
directory: "/"
schedule:
interval: "weekly"
Expand Down
5 changes: 5 additions & 0 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
approvers:
- ceph-csi-team

reviewers:
- ceph-csi-team
8 changes: 8 additions & 0 deletions OWNERS_ALIASES
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
aliases:
ceph-csi-team:
- agarwal-mudit
- madhu-1
- nixpanic
- rakshith-r
- riya-singhal31
- yati1998
5 changes: 3 additions & 2 deletions config/manifests/bases/clusterserviceversion.yaml.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
alm-examples: '[]'
capabilities: Basic Install
olm.skipRange: @SKIP_RANGE@
operators.operatorframework.io/operator-type: non-standalone
name: @[email protected]
namespace: placeholder
spec:
Expand Down Expand Up @@ -45,8 +46,8 @@ spec:
storage operations for CSI-drivers.
displayName: CSI Addons
icon:
- base64data: ""
mediatype: ""
- base64data: PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxOTIgMTQ1Ij48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2UwMDt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPlJlZEhhdC1Mb2dvLUhhdC1Db2xvcjwvdGl0bGU+PHBhdGggZD0iTTE1Ny43Nyw2Mi42MWExNCwxNCwwLDAsMSwuMzEsMy40MmMwLDE0Ljg4LTE4LjEsMTcuNDYtMzAuNjEsMTcuNDZDNzguODMsODMuNDksNDIuNTMsNTMuMjYsNDIuNTMsNDRhNi40Myw2LjQzLDAsMCwxLC4yMi0xLjk0bC0zLjY2LDkuMDZhMTguNDUsMTguNDUsMCwwLDAtMS41MSw3LjMzYzAsMTguMTEsNDEsNDUuNDgsODcuNzQsNDUuNDgsMjAuNjksMCwzNi40My03Ljc2LDM2LjQzLTIxLjc3LDAtMS4wOCwwLTEuOTQtMS43My0xMC4xM1oiLz48cGF0aCBjbGFzcz0iY2xzLTEiIGQ9Ik0xMjcuNDcsODMuNDljMTIuNTEsMCwzMC42MS0yLjU4LDMwLjYxLTE3LjQ2YTE0LDE0LDAsMCwwLS4zMS0zLjQybC03LjQ1LTMyLjM2Yy0xLjcyLTcuMTItMy4yMy0xMC4zNS0xNS43My0xNi42QzEyNC44OSw4LjY5LDEwMy43Ni41LDk3LjUxLjUsOTEuNjkuNSw5MCw4LDgzLjA2LDhjLTYuNjgsMC0xMS42NC01LjYtMTcuODktNS42LTYsMC05LjkxLDQuMDktMTIuOTMsMTIuNSwwLDAtOC40MSwyMy43Mi05LjQ5LDI3LjE2QTYuNDMsNi40MywwLDAsMCw0Mi41Myw0NGMwLDkuMjIsMzYuMywzOS40NSw4NC45NCwzOS40NU0xNjAsNzIuMDdjMS43Myw4LjE5LDEuNzMsOS4wNSwxLjczLDEwLjEzLDAsMTQtMTUuNzQsMjEuNzctMzYuNDMsMjEuNzdDNzguNTQsMTA0LDM3LjU4LDc2LjYsMzcuNTgsNTguNDlhMTguNDUsMTguNDUsMCwwLDEsMS41MS03LjMzQzIyLjI3LDUyLC41LDU1LC41LDc0LjIyYzAsMzEuNDgsNzQuNTksNzAuMjgsMTMzLjY1LDcwLjI4LDQ1LjI4LDAsNTYuNy0yMC40OCw1Ni43LTM2LjY1LDAtMTIuNzItMTEtMjcuMTYtMzAuODMtMzUuNzgiLz48L3N2Zz4=
mediatype: image/svg+xml
install:
spec:
deployments: null
Expand Down
91 changes: 91 additions & 0 deletions redhat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# ODF: kubernetes-csi-addons

Repository where [csi-addons/kubernetes-csi-addons][upstream-k8s-csi-addons] is
maintained for the OpenShift Data Foundation product.

## Git Repository

### Branches

This GitHub repository contains branches for different product versions.

## Backports

All changes in this repository are *backports* from the [upstream
project][upstream-k8s-csi-addons]. There should be no functional changes (only
process/CI/building/..) in this repository compared to the upstream project.
Fixes for any of the release branches should first land in the `main` branch
before they may be backported to the release branch. A backport for the oldest
release should also be backported to all the newer releases in order to prevent
re-introducing a bug when a user updates.

### Sync `main` with upstream `csi-addons/kubernetes-csi-addons:main`

Syncing branches (including the `main` branch) from upstream should be done
with a Pull-Request. To create a PR that syncs the latest changes from
`csi-addons/kubernetes-csi-addons:main` into the `main` branch, [click
here][sync-pr].

If any conflicts arises while syncing the latest changes from
`csi-addons/kubernetes-csi-addons:main` into the `main` branch, instead
rebase the downstream `main` branch on top of `csi-addons/kubernetes-csi-addons:main`
and resolve those conflicts. This will make sure the conflicts are resolved
in one of the `downstream-only` commits and will make further syncing of the
upstream changes seamless.

### Backporting changes from the `main` to `release-*` branches

Once a PR has been merged in the `main` branch that fixes an issue, a new PR
with the backport can be created. The easiest way is to use a command like

/cherry-pick release-4.10

The **openshift-cherrypick-robot** will automatically create a new PR for the
selected branch.

### Pull Requests

Once the product planning enters feature freeze, only backports with related
Bugzilla references will be allowed to get merged.

To assist developers, there are several Pull Request templates available. It is
recommended to use these links when creating a new Pull Request:

- [backport][backport-pr]: `?template=redhat-backport.md`
- [downstream-only][ds-only-pr]: `?template=redhat-downstream-only.md`
- [sync][sync-pr]: or add `?template=redhat-sync.md`

The `?template=...` appendix can be used when creating the Pull Requests
through other means than the links above. By appending the `?template=...`
keyword to the Pull Request URL, the template gets included automatically.

### Downstream-Only Changes

For working with the downstream tools, like OpenShift CI, there are a few
changes required that are not suitable for the upstream Ceph-CSI project.

1. `OWNERS` file: added with maintainers for reviewing and approving PRs
1. `OWNERS_ALIASES` file: members of the Ceph-CSI team
1. `redhat/` directory: additional files (like this `README.md`)
1. `.github/PULL_REQUEST_TEMPLATE/redhat-*`: guidance for creating PRs

## Continuous Integration

OpenShift CI (Prow) is used for testing the changes that land in this GitHub
repository. The configuration of the jobs can be found in the [OpenShift
Release repository][ocp-release].

### Bugzilla Plugin

PRs that need a Bugzilla reference are handled by the Bugzilla Plugin which
runs as part of Prow. The configuration gates the requirement on BZs to be
linked, before the tests will pass and the PR can be merged. Once a branch is
added to the GitHub repository, [the configuration][bz-config] needs adaption
for the new branch as well.

[upstream-k8s-csi-addons]: https://github.com/csi-addons/kubernetes-csi-addons
[sync-pr]: https://github.com/red-hat-storage/kubernetes-csi-addons/compare/main...csi-addons:main?template=redhat-sync.md
[backport-pr]: https://github.com/red-hat-storage/kubernetes-csi-addons/compare/release-4.10...main?template=redhat-backport.md
[ds-only-pr]: https://github.com/red-hat-storage/kubernetes-csi-addons/compare/main...csi-addons:main?template=redhat-downstream-only.md
[ocp-release]: https://github.com/openshift/release/tree/master/ci-operator/config/red-hat-storage/kubernetes-csi-addons
[bz-config]: https://github.com/openshift/release/blob/master/core-services/prow/02_config/red-hat-storage/kubernetes-csi-addons/_pluginconfig.yaml