Skip to content

Commit

Permalink
add note about vulnerability_alerts
Browse files Browse the repository at this point in the history
  • Loading branch information
lancehampton committed Jun 25, 2024
1 parent 8a75314 commit 18ad1d5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
12 changes: 8 additions & 4 deletions modules/repository/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,21 @@

This module creates a GitHub repository that complies with the [CIS Software Supply Chain Security Guide 1.0](https://github.com/aquasecurity/chain-bench/blob/main/docs/CIS-Software-Supply-Chain-Security-Guide-v1.0.pdf).

> [!NOTE]
> `vulnerability_alerts` should be true for GitHub Enterprise Cloud (GHEC) and false for GitHub Enterprise Server (GHES). GHES requires additional configuration to enable security alerts for vulnerable dependencies. See [this doc page](https://docs.github.com/en/[email protected]/admin/configuring-settings/configuring-github-connect/enabling-dependabot-for-your-enterprise) for more information.
## Usage

```hcl
module "repository" {
source = "github.com/stigian/terraform-github-archimedes//modules/repository"
version = "0.1.0"
name = "example-repo"
description = "example-description"
visibility = "private"
push_allowances = ["example-org/example-team"] # org-name/team-name
name = "example-repo"
description = "example-description"
visibility = "private"
push_allowances = ["example-org/example-team"] # org-name/team-name
vulnerability_alerts = true
}
```

Expand Down
4 changes: 2 additions & 2 deletions modules/team-repository/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ If you are using something like [Entra ID](https://learn.microsoft.com/en-us/ent

```hcl
module "team_assignment" {
source = "github.com/stigian/terraform-github-archimedes//modules/team-repository"
source = "github.com/stigian/terraform-github-archimedes//modules/team-repository"
version = "0.1.0"
repository = "example-repo"
teams = [
teams = [
{
name = "team1"
role = "admin"
Expand Down
2 changes: 1 addition & 1 deletion modules/team/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This module creates teams in a GitHub Enterprise organization. You can use this

```hcl
module "team" {
source = "github.com/stigian/terraform-github-archimedes//modules/team"
source = "github.com/stigian/terraform-github-archimedes//modules/team"
version = "0.1.0"
name = "team1"
Expand Down

0 comments on commit 18ad1d5

Please sign in to comment.