diff --git a/.github/spell-ignore-words.txt b/.github/spell-ignore-words.txt new file mode 100644 index 00000000000..7bdb3b371b1 --- /dev/null +++ b/.github/spell-ignore-words.txt @@ -0,0 +1,4 @@ +Snyk +dpkg +pipenv +datasource diff --git a/AUDIT-CONFIG.md b/AUDIT-CONFIG.md index 61bece5e8ef..9a271389bef 100644 --- a/AUDIT-CONFIG.md +++ b/AUDIT-CONFIG.md @@ -11,14 +11,14 @@ - **Items** _(string)_ - **`pipenv-sync-arguments`** _(array)_: Arguments to pass to pipenv sync. Default: `[]`. - **Items** _(string)_ - - **`monitor-arguments`** _(array)_: Arguments to pass to snyk monitor. Default: `["--all-projects"]`. + - **`monitor-arguments`** _(array)_: Arguments to pass to Snyk monitor. Default: `["--all-projects"]`. - **Items** _(string)_ - - **`test-arguments`** _(array)_: Arguments to pass to snyk test. Default: `["--all-projects", "--severity-threshold=medium"]`. + - **`test-arguments`** _(array)_: Arguments to pass to Snyk test. Default: `["--all-projects", "--severity-threshold=medium"]`. - **Items** _(string)_ - - **`fix-arguments`** _(array)_: Arguments to pass to snyk fix. Default: `["--all-projects"]`. + - **`fix-arguments`** _(array)_: Arguments to pass to Snyk fix. Default: `["--all-projects"]`. - **Items** _(string)_ - **`dpkg`** _(object)_: Cannot contain additional properties. - - **`enabled`** _(boolean)_: Enable Dpkg audit. Default: `true`. + - **`enabled`** _(boolean)_: Enable dpkg audit. Default: `true`. - **`sources`** _(object)_: Can contain additional properties. Default: `{"ubuntu_22_04": [{"url": "http://archive.ubuntu.com/ubuntu", "distribution": "jammy", "components": ["main", "restricted", "universe", "multiverse"]}, {"url": "http://security.ubuntu.com/ubuntu", "distribution": "jammy-security", "components": ["main", "restricted", "universe", "multiverse"]}, {"url": "http://security.ubuntu.com/ubuntu", "distribution": "jammy-updates", "components": ["main", "restricted", "universe", "multiverse"]}], "ubuntu_24_04": [{"url": "http://archive.ubuntu.com/ubuntu", "distribution": "noble", "components": ["main", "restricted", "universe", "multiverse"]}, {"url": "http://security.ubuntu.com/ubuntu", "distribution": "noble-security", "components": ["main", "restricted", "universe", "multiverse"]}, {"url": "http://security.ubuntu.com/ubuntu", "distribution": "noble-updates", "components": ["main", "restricted", "universe", "multiverse"]}], "debian_11": [{"url": "http://deb.debian.org/debian", "distribution": "bullseye", "components": ["main", "contrib", "non-free"]}, {"url": "http://deb.debian.org/debian", "distribution": "bullseye-updates", "components": ["main", "contrib", "non-free"]}, {"url": "http://security.debian.org/debian-security", "distribution": "bullseye-security", "components": ["main", "contrib", "non-free"]}], "debian_12": [{"url": "http://deb.debian.org/debian", "distribution": "bookworm", "components": ["main", "contrib", "non-free"]}, {"url": "http://deb.debian.org/debian", "distribution": "bookworm-updates", "components": ["main", "contrib", "non-free"]}, {"url": "http://security.debian.org/debian-security", "distribution": "bookworm-security", "components": ["main", "contrib", "non-free"]}]}`. - **Additional properties** _(array)_ - **Items** _(object)_ diff --git a/github_app_geo_project/module/audit/configuration.py b/github_app_geo_project/module/audit/configuration.py index 86b41a02e69..960e07433eb 100644 --- a/github_app_geo_project/module/audit/configuration.py +++ b/github_app_geo_project/module/audit/configuration.py @@ -100,9 +100,9 @@ class DpkgConfiguration(TypedDict, total=False): enabled: bool """ - Enable Dpkg. + Enable dpkg. - Enable Dpkg audit + Enable dpkg audit default: True """ @@ -262,14 +262,14 @@ class DpkgConfiguration(TypedDict, total=False): "pipenv-sync-arguments": list[str], # Snyk monitor arguments. # - # Arguments to pass to snyk monitor + # Arguments to pass to Snyk monitor # # default: # - --all-projects "monitor-arguments": list[str], # Snyk test arguments. # - # Arguments to pass to snyk test + # Arguments to pass to Snyk test # # default: # - --all-projects @@ -277,7 +277,7 @@ class DpkgConfiguration(TypedDict, total=False): "test-arguments": list[str], # Snyk fix arguments. # - # Arguments to pass to snyk fix + # Arguments to pass to Snyk fix # # default: # - --all-projects diff --git a/github_app_geo_project/module/audit/schema.json b/github_app_geo_project/module/audit/schema.json index 7107b5face5..02730ade96c 100644 --- a/github_app_geo_project/module/audit/schema.json +++ b/github_app_geo_project/module/audit/schema.json @@ -51,7 +51,7 @@ "monitor-arguments": { "type": "array", "title": "Snyk monitor arguments", - "description": "Arguments to pass to snyk monitor", + "description": "Arguments to pass to Snyk monitor", "default": ["--all-projects"], "items": { "type": "string" @@ -60,7 +60,7 @@ "test-arguments": { "type": "array", "title": "Snyk test arguments", - "description": "Arguments to pass to snyk test", + "description": "Arguments to pass to Snyk test", "default": ["--all-projects", "--severity-threshold=medium"], "items": { "type": "string" @@ -69,7 +69,7 @@ "fix-arguments": { "type": "array", "title": "Snyk fix arguments", - "description": "Arguments to pass to snyk fix", + "description": "Arguments to pass to Snyk fix", "default": ["--all-projects"], "items": { "type": "string" @@ -84,8 +84,8 @@ "properties": { "enabled": { "type": "boolean", - "title": "Enable Dpkg", - "description": "Enable Dpkg audit", + "title": "Enable dpkg", + "description": "Enable dpkg audit", "default": true }, "sources": {