Skip to content

Commit 16dca48

Browse files
Merge branch 'main' into feat/gateway-api-support
2 parents cbb8ca3 + be3bc00 commit 16dca48

File tree

3 files changed

+57
-17
lines changed

3 files changed

+57
-17
lines changed

AGENTS.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Agent Guidance for the oauth2-proxy Helm Chart
2+
3+
This repository hosts the community Helm chart for deploying [oauth2-proxy](https://github.com/oauth2-proxy/oauth2-proxy). Automated or human agents working in this repo should prioritize clarity, reproducibility, and reviewer trust.
4+
5+
## Mission and scope
6+
7+
- Keep the chart aligned with upstream oauth2-proxy releases and Kubernetes best practices.
8+
- Ensure every functional change ships with updated values, docs, and tests where applicable.
9+
- Maintain a clear audit trail so reviewers can understand *why* a change exists and how it was validated.
10+
11+
## Context to load first
12+
13+
- `helm/oauth2-proxy/Chart.yaml` – chart metadata, versioning, Artifact Hub annotations.
14+
- `helm/oauth2-proxy/values.yaml` – defaults you must update when adding new flags/behavior.
15+
- `helm/oauth2-proxy/README.md` – source of truth for documented configuration knobs.
16+
- `ct.yaml` – configuration for `chart-testing`; run `ct lint --config ct.yaml` before requesting review.
17+
- `helm/oauth2-proxy/ci/*.yaml` – sample value files that double as regression cases.
18+
19+
## Quality checklist before opening a PR
20+
21+
- [ ] Chart version bumped when any template, values, or docs change.
22+
- [ ] `artifacthub.io/changes` updated when user-facing behavior changes.
23+
- [ ] New/changed values documented in both `values.yaml` (with clear comments) and `helm/oauth2-proxy/README.md` tables.
24+
- [ ] Tests/lint (`ct lint` and, if needed, `ct install`) executed and exits captured in the PR description.
25+
- [ ] Any required secrets or sample manifests documented so reviewers can reproduce.
26+
27+
## AI attribution (keep it brief but visible)
28+
29+
We encourage useful automation, but reviewers must know when AI meaningfully shaped a change. Mark substantial AI assistance by append a commit trailer such as `Assisted-by: <tool or service>`.
30+
31+
Trivial autocomplete (variable names, single-line suggestions you fully rewrote) does **not** need disclosure. When in doubt, disclose.
32+
33+
## Need updates?
34+
35+
If the expectations in this file stop reflecting the team’s workflow, propose edits via an issue or PR referencing `agents.md`. Keeping these guidelines current helps both humans and agents land safe, reviewable changes.

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Contributing
22

3-
This repository is the official **community maintained** helm chart for oauth2-proxy and is not to be confused with the helm chart published by bitnami. We rely on you to test your changes sufficiently.
3+
This repository is the official **community maintained** helm chart for OAuth2 Proxy and is not to be confused with the helm chart published by bitnami. We rely on you to test your changes sufficiently.
44

55
## Pull Requests
66

7-
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.
7+
All submissions, including submissions by project members, require a review. We use GitHub pull requests for this purpose.
88

99
### Pull Request Title
1010

@@ -16,7 +16,7 @@ The documentation in the chart [README.md](charts/oauth2-proxy) and the `values.
1616

1717
### Artifact Hub Annotation
1818

19-
Since we release the chart on Artifact Hub we require you to update the `artifacthub.io/changes` annotation in the `Chart.yaml`.
19+
Since we have rolling release and publish the chart on Artifact Hub, we require you to update the `artifacthub.io/changes` annotation in the `Chart.yaml` for every PR.
2020

2121
* [https://artifacthub.io/docs/topics/annotations/helm/](https://artifacthub.io/docs/topics/annotations/helm/)
2222

@@ -25,11 +25,11 @@ Since we release the chart on Artifact Hub we require you to update the `artifac
2525

2626
We follow the [semver standard](https://semver.org/) for the chart version and application version.
2727

28-
Always consider your changes and try to avoid breaking changes where possible.
28+
Always consider your changes and try to avoid breaking changes whenever possible.
2929

3030
### New Application Versions
3131

32-
The application version is only to be updated if a new release of the oauth2-proxy application repo was published.
32+
The application version is only to be updated if a new release of the OAuth2 Proxy application repo was published.
3333

3434
### Immutability
3535

@@ -38,27 +38,27 @@ Each release must be immutable. Any change to a chart (even just documentation)
3838

3939
## Testing
4040

41-
When making changes to the logic or resources of the chart please make sure you tested those changes in two ways:
41+
When making changes to the logic or resources of the chart, please make sure you tested those changes in two ways:
4242

4343
* Existing helm release with the chart version before your changes: `helm upgrade`
44-
* Fresh helm release with you changes: `helm install`
44+
* Fresh helm release with your changes: `helm install`
4545

4646

4747
### Testing Charts
4848

49-
As part of the Continuous Integration system we run Helm's [Chart Testing](https://github.com/helm/chart-testing) tool.
49+
As part of the Continuous Integration, we run Helm's [Chart Testing](https://github.com/helm/chart-testing) tool.
5050

5151
The checks for Chart Testing are stricter than the standard Helm requirements.
5252

5353
The configuration can be found in [ct.yaml](ct.yaml)
5454

55-
If you have `ct` installed you can manually invoke the linting with the following command:
55+
If you have `ct` installed, you can manually invoke the linting with the following command:
5656

5757
```shell
5858
ct lint --config ct.yaml
5959
```
6060

61-
If you want to run the tests locally we recommend to use [kind](https://kind.sigs.k8s.io).
61+
If you want to run the tests locally, we recommend to use [kind](https://kind.sigs.k8s.io) to setup a local cluster.
6262

6363
Prerequisites:
6464

@@ -67,12 +67,12 @@ Prerequisites:
6767
kubectl apply --server-side -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/release-0.78/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml
6868
```
6969

70-
Run the tests:
70+
Run the tests (takes up to 10 minutes):
7171

7272
```shell
7373
ct --config ct.yaml install
7474
```
7575

7676
## Publishing Changes
7777

78-
Changes are automatically publish whenever a commit is merged to the `main` branch by the CI job (see `./.github/workflows/release.yml`).
78+
Changes are automatically publish, whenever a commit is merged to the `main` branch by the CI job (see `./.github/workflows/release.yml`).

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# manifests
22

3-
For hosting manifests to allow for the deployment of OAuth2-Proxy/OAuth2-Proxy
3+
For hosting manifests to allow for the deployment of [OAuth2 Proxy](https://github.com/oauth2-proxy/oauth2-proxy)
44

55
## Helm Chart
66

@@ -20,6 +20,11 @@ ct lint --all --config ct.yaml
2020
ct install --all --config ct.yaml
2121
```
2222

23+
## Contributing
24+
25+
If you want to contribute to this project, please make yourself familiar with the [CONTRIBUTING.md](https://github.com/oauth2-proxy/manifests/tree/main/CONTRIBUTING.md) guide before opening a PR or issue.
26+
Be aware this is just the Helm chart / manifest repository. Actual problems with the application OAuth2 Proxy itself should be reported in the main project repository.
27+
2328
## Verify Signed Helm Charts
2429

2530
With the introduction of cosign for signing artifacts you can verify the
@@ -43,19 +48,19 @@ more about how keyless signing is done, visit the official documentation about
4348

4449

4550
## Code of Conduct
46-
Participation in the OAuth2-Proxy project is governed by the [CNCF Code of Conduct](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/CODE_OF_CONDUCT.md).
51+
Participation in the OAuth2 Proxy project is governed by the [CNCF Code of Conduct](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/CODE_OF_CONDUCT.md).
4752

4853
## License
4954

50-
OAuth2-Proxy is distributed under [The MIT License](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/LICENSE).
55+
OAuth2 Proxy is distributed under [The MIT License](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/LICENSE).
5156

5257
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Foauth2-proxy%2Fmanifests.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Foauth2-proxy%2Fmanifests?ref=badge_large&issueType=license)
5358

54-
The OAuth2-Proxy helm chart is distributed under [Apache License 2.0](https://github.com/oauth2-proxy/manifests/tree/main/LICENSE).
59+
The OAuth2 Proxy helm chart is distributed under [Apache License 2.0](https://github.com/oauth2-proxy/manifests/tree/main/LICENSE).
5560

5661
## Trademarks
5762

58-
OAuth2-Proxy is a [Cloud Native Computing Foundation](https://cncf.io) Sandbox project.
63+
OAuth2 Proxy is a [Cloud Native Computing Foundation](https://cncf.io) Sandbox project.
5964

6065
![CNCF](https://www.cncf.io/wp-content/uploads/2023/04/cncf-main-site-logo.svg)
6166

0 commit comments

Comments
 (0)