-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #144 from IBM/release-v1.1.0
Release v1.1.0
- Loading branch information
Showing
29 changed files
with
2,085 additions
and
289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # IBM Operator Collection SDK for VS Code integrated linter configuration | ||
|
|
||
| The IBM Operator Collection SDK for VS Code has a built-in linter meant to validate your operator-config, | ||
| By default the following rules are applied: | ||
|
|
||
| - `missing-galaxy` | ||
| - Missing `galaxy.yaml` file errors. | ||
| - `match-domain` | ||
| - `galaxy.yml` file `domain` mismatch | ||
| - `match-name` | ||
| - `galaxy.yml` file `name` mismatch | ||
| - `match-version` | ||
| - `galaxy.yml` file `version` mismatch | ||
| - `ansible-config` | ||
| - Build includes `ansible.cfg` error | ||
| - `playbook-path` | ||
| - Playbook relative path validation error | ||
| - `hosts-all` | ||
| - Playbook hosts validation | ||
| - `missing-playbook` | ||
| - Validate Playbook existence | ||
| - `finalizer-path` | ||
| - Finalizer relative path validation error | ||
| - `missing-finalizer` | ||
| - Validate Finalizer existence | ||
|
|
||
| You can customize the linter rules and files to ignore to suit your needs. You can ignore certain rules, enable rules, and ignore files from linting. | ||
|
|
||
| The IBM Operator Collection SDK for VS Code Operator Collection Linter loads configuration from a file in the directory where the operator-config is located, | ||
| Specify this configuration in `.oc-lint` a yaml file that contains the following format: | ||
|
|
||
| ``` | ||
| --- | ||
| # .oc-lint | ||
| # List of files for the linter to ignore. | ||
| exclude_paths: | ||
| - '**' | ||
| # Use all the default linter rules | ||
| use_default_rules: true | ||
| # List of rules to skip linting. | ||
| skip_list: | ||
| - match-domain | ||
| # List of additional rules to enable. | ||
| enable_list: | ||
| - hosts-all | ||
| ``` | ||
|
|
||
| Where: | ||
| - `exlude_paths` defines a glob pattern to ignore when matching against the files the linter will process. | ||
| - `use_default_rules` Enables all the linting rules to be applied. | ||
| - `skip_list` Lists all the rules you want disabled. | ||
| - `enable_list` Lists all the rules you want to explicitly enable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-06/schema#", | ||
| "$ref": "#/definitions/OcLinterConfig", | ||
| "definitions": { | ||
| "Rule": { | ||
| "type": "string", | ||
| "oneOf": [ | ||
| {"const":"missing-galaxy", | ||
| "markdownDescription": "#### Description\r\nMissing `galaxy.yaml` file errors." | ||
| }, | ||
| {"const":"match-domain", | ||
| "markdownDescription": "#### Description\r\n`galaxy.yml` file domain mismatch" | ||
| }, | ||
| {"const":"match-name", | ||
| "markdownDescription": "#### Description\r\n`galaxy.yml` file name mismatch" | ||
| }, | ||
| {"const":"match-version", | ||
| "markdownDescription": "#### Description\r\n`galaxy.yml` file version mismatch" | ||
| }, | ||
| {"const":"ansible-config", | ||
| "markdownDescription": "#### Description\r\nBuild includes `ansible.cfg` error" | ||
| }, | ||
| {"const":"playbook-path", | ||
| "markdownDescription": "#### Description\r\nPlaybook relative path validation error" | ||
| }, | ||
| {"const":"hosts-all", | ||
| "markdownDescription": "#### Description\r\nPlaybook hosts validation" | ||
| }, | ||
| {"const":"finalizer-path", | ||
| "markdownDescription": "#### Description\r\nFinalizer relative path validation error" | ||
| }, | ||
| {"const":"missing-finalizer", | ||
| "markdownDescription": "#### Description\r\nValidate Finalizer existence" | ||
| }, | ||
| {"const":"missing-playbook", | ||
| "markdownDescription": "#### Description\r\nValidate Playbook existence" | ||
| } | ||
| ] | ||
| }, | ||
| "OcLinterConfig": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "exclude_paths": { | ||
| "markdownDescription": "#### Description\r\nList of files for the linter to ignore.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "use_default_rules": { | ||
| "markdownDescription": "#### Description\r\nUse all the default linter rules.", | ||
| "type": "boolean" | ||
| }, | ||
| "skip_list": { | ||
| "markdownDescription": "#### Description\r\nList of rules to skip linting.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "$ref": "#/definitions/Rule" | ||
| } | ||
| }, | ||
| "enable_list": { | ||
| "markdownDescription": "#### Description\r\nList of additional rules to enable.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "$ref": "#/definitions/Rule" | ||
| } | ||
| } | ||
| }, | ||
| "required": [] | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.