Skip to content

Commit 707f47b

Browse files
authored
update readme and flip rule to error level (#120)
1 parent cb91d05 commit 707f47b

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ This method is useful for developers who want to contribute to the project or ne
9292

9393
### Setup settings.yaml
9494

95-
If a non-default configuration is desired (different than `src/bitwarden_workflow_linter/default_settings.yaml`), copy the below and create a `settings.yaml` in the directory that `bwwl` will be running from.
95+
If a non-default configuration is desired (different than `src/bitwarden_workflow_linter/default_settings.yaml`), copy the below and create a `settings.yaml` in the directory that `bwwl` will be running from ( generally will be the root directory in CI).
9696

9797
```yaml
9898
enabled_rules:
@@ -104,14 +104,21 @@ enabled_rules:
104104
level: error
105105
- id: bitwarden_workflow_linter.rules.job_environment_prefix.RuleJobEnvironmentPrefix
106106
level: error
107+
- id: bitwarden_workflow_linter.rules.step_approved.RuleStepUsesApproved
108+
level: error
107109
- id: bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
108110
level: error
109111
- id: bitwarden_workflow_linter.rules.underscore_outputs.RuleUnderscoreOutputs
110112
level: warning
111113
- id: bitwarden_workflow_linter.rules.run_actionlint.RunActionlint
112114
level: warning
115+
- id: bitwarden_workflow_linter.rules.check_pr_target.RuleCheckPrTarget
116+
level: error
117+
- id: bitwarden_workflow_linter.rules.permissions_exist.RulePermissionsExist
118+
level: warning
113119

114120
approved_actions_path: default_actions.json
121+
default_branch: main
115122
```
116123
117124
### Command Line Usage

settings.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ enabled_rules:
1616
- id: bitwarden_workflow_linter.rules.run_actionlint.RunActionlint
1717
level: warning
1818
- id: bitwarden_workflow_linter.rules.check_pr_target.RuleCheckPrTarget
19-
level: warning
19+
level: error
2020
- id: bitwarden_workflow_linter.rules.permissions_exist.RulePermissionsExist
2121
level: warning
2222

src/bitwarden_workflow_linter/default_settings.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ enabled_rules:
1616
- id: bitwarden_workflow_linter.rules.run_actionlint.RunActionlint
1717
level: warning
1818
- id: bitwarden_workflow_linter.rules.check_pr_target.RuleCheckPrTarget
19-
level: warning
19+
level: error
2020
- id: bitwarden_workflow_linter.rules.permissions_exist.RulePermissionsExist
2121
level: warning
2222

0 commit comments

Comments
 (0)