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.

Sign up for GitHub

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

WPB-5017: Adding a test config file to the PR guidelines. #3624

Merged
merged 4 commits into from
Oct 16, 2023
Merged

WPB-5017: Adding a test config file to the PR guidelines. #3624

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac4f61b
Hotfix: Adding a test config file to the PR guidelines.
lepsa Sep 29, 2023
8f9995a
Adding a changelog
lepsa Sep 29, 2023
442b34c
Merge remote-tracking branch 'origin/develop' into pr-guidelines-fix
lepsa Oct 11, 2023
4372079
Update based on PR feedback
lepsa Oct 11, 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
1 change: 1 addition & 0 deletions changelog.d/4-docs/hotfix-pr-guidelines
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Adding a testing config entry to the PR guidelines.
2 changes: 1 addition & 1 deletion docs/src/developer/developer/pr-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Add to `charts/nginz/values.yaml`, under the `galley` section:
If a PR adds new configuration options for say brig, the following files need to be edited:

* [ ] The parser under `services/brig/src/Brig/Options.hs`
* [ ] The integration test config: `services/brig/brig.integration.yaml`
* [ ] The integration test config: `services/brig/brig.integration.yaml` and `charts/cargohold/templates/tests/configmap.yaml`
Copy link
Contributor

Choose a reason for hiding this comment

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

ah, wait, this was already documented, but you have to read the context carefully. this list is an example for the context where you made changes to brig. for cargohold, most items in this list will change.

do you have a suggestion how to make this more clear? maybe introduce variables $Service and $service to use in the list instead of brig?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Variables would work, I think. I'll sit with this a bit and see what I can come up with.

* [ ] The charts: `charts/brig/templates/configmap.yaml`
* [ ] The default values: `charts/brig/values.yaml`
* [ ] The values files for CI: `hack/helm_vars/wire-server/values.yaml.gotmpl`
Expand Down