Parameterize GitHub org and team settings #240

New issue

Closed

opened 2024-10-02 09:08:10 +00:00 by fricklerhandwerk · 2 comments

fricklerhandwerk commented

2024-10-02 09:08:10 +00:00

(Migrated from github.com)

As a contributor, in my development shell I want to conveniently override application settings, such as the org and teams to sync with.

Currently one can't run the service locally without manually changing the GitHub parameters, or manually create a USER_SETTINGS_FILE. There is a way to generate that file programmatically which is accessible to the module.

Extract that functionality into a helper script that is available in the devshell and will create the right thing from an untracked directory, e.g.

.settings
├── GH_COMMITTERS_TEAM
├── GH_ORGANIZATION
└── GH_SECURITY_TEAM

As a contributor, in my development shell I want to conveniently override application settings, such as the org and teams to sync with. Currently one can't run the service locally without manually changing the [GitHub parameters](https://github.com/Nix-Security-WG/nix-security-tracker/blob/main/src/website/tracker/settings.py#L281-L287), or manually [create a `USER_SETTINGS_FILE`](https://github.com/Nix-Security-WG/nix-security-tracker/blob/main/src/website/tracker/settings.py#L295-L303). There is a way to [generate that file programmatically](https://github.com/Nix-Security-WG/nix-security-tracker/blob/main/nix/web-security-tracker.nix#L22-L24) which is accessible to the module. Extract that functionality into a helper script that is available in the devshell and will create the right thing from an untracked directory, e.g. ``` .settings ├── GH_COMMITTERS_TEAM ├── GH_ORGANIZATION └── GH_SECURITY_TEAM ```

proofconstruction commented

2024-10-03 03:42:26 +00:00

(Migrated from github.com)

What does this accomplish that just creating the USER_SETTINGS_FILE doesn't?

What does this accomplish that just creating the `USER_SETTINGS_FILE` doesn't?

fricklerhandwerk commented

2024-11-11 10:09:57 +00:00

(Migrated from github.com)

The workflow is now documented in CONTRIBUTING.md and has a bit of helper code in default.nix for the shell