EnvGene Linter

• Install
• Run a check
• Open the report
• Optional commands
• Troubleshooting

EnvGene Linter checks EnvGene instance and template repositories and saves findings in an HTML report. Template-only repositories are checked by TPL-1 only. Other implemented checks require instance inputs.

Install

You need Python 3.12 or newer with pip. The Python command can be named python or python3, depending on your installation. Check which command is available with python --version or python3 --version. Use one of the following commands with Python 3.12 or newer to install or update the tool:

python -m pip install --upgrade qubership-envgene-linter

Or, if your Python command is python3:

python3 -m pip install --upgrade qubership-envgene-linter

On Windows, you can also use py -m pip if the Python launcher is installed. You do not need to download the source code or build the package.

Run a check

Open a terminal in your repository root: the directory containing environments/, templates/, or both. Run:

envgene-linter check

Open the report

When the check finishes, the terminal shows the report location, for example:

Report saved to: /path/to/instance-repository/envgene-linter-report.html

Open that HTML file in your browser. Each finding shows the affected file, the issue, and a suggested action. The linter does not fix configuration files automatically.

Every successful check replaces the previous report. The report filename is added to the repository's .gitignore. Errors and messages about skipped files appear in the terminal. Review those messages if a file could not be checked.

Optional commands

To also display findings in the terminal:

envgene-linter check --console

To check a repository without changing directories:

envgene-linter check /path/to/instance-repository

Both commands also create the HTML report.

Troubleshooting

• If pip reports externally-managed-environment, install in a Python virtual environment. A virtual environment is optional for the linter, but some systems require one for pip installations.
• If the terminal cannot find envgene-linter, check that your Python scripts directory is on PATH. If you installed in a virtual environment, activate that environment first.
• If neither environments/ nor templates/ is found, run the command from the repository root.
• For template-only repositories, Not applicable marks checks that are not yet supported in this mode. TPL-1 still runs unless disabled.

This is an alpha release. Most checks cover supported references and generator inputs. TPL-1 checks YAML and template placement under templates/, environments/, and configuration/. Exit code 0 means the check completed, including runs with findings. Exit code 2 indicates a command or execution error.

EnvGene Linter changelog

• 0.0.5
• 0.0.4
• 0.0.3
• 0.0.2
• 0.0.1

0.0.5

• Hide disabled rules in HTML and console reports. If every rule is disabled, show No rules enabled.
• Support template repositories containing templates/ without requiring environments/. TPL-1 runs on these repositories. Other checks are not yet supported for template-only repositories.
• Add TPL-1, enabled by default, to check YAML and .j2 placement under templates/, environments/, and configuration/. Allow generator-rendered descriptor fields and EnvGene macros. Report misplaced templates and EnvGene Jinja as Fix, and ambiguous Helm or application placeholders as Review. No automatic conversion or renaming is performed.
• Add VAL-4, enabled by default, to review JSON collections and YAML block collections encoded as strings in connected ParameterSets, including application parameters and nested values. Findings recommend native YAML after checking the consumer contract. No automatic conversion is performed.

0.0.4

• Add INT-3 to report used reference names defined at multiple environment, cluster, or repository scopes. Checks cover ParameterSets, shared Credential files, Resource Profile Overrides, and Shared Template Variables.
• Add INT-4 to flag authored entities for which no references were found in available local sources. Findings recommend Review and explain uncertainty, including external templates and rendered references. The rule does not establish that removal is safe or delete entities automatically.
• Add NAME-8 to check that selected default Cloud Passports use the filename stem passport and their selected companion Credential files use passport-creds. The passport-infra file and its companion are excluded.
• Enable INT-3, INT-4, and NAME-8 by default.
• Remove the Type row and its colored chips from HTML findings. Cards retain File, Issue, Action, and Fix suggestion. Console severity remains unchanged.
• Show the repository's root folder name below the HTML report heading and in the browser tab title. Escape special characters and show the name even when there are no findings.

0.0.3

No functional changes from 0.0.2.

0.0.2

• Allow envgene-linter check without a repository argument to check the current directory. Explicit repository paths remain supported.
• Create or update envgene-linter-report.html by default and print its absolute path.
• Add --console to also print findings in the terminal. Errors and parsing diagnostics remain visible by default.
• Remove --html. HTML reports are generated automatically, including when --console is used.

To migrate from 0.0.1, remove --html from existing commands. Add --console to commands that need findings on stdout, including shell redirection and CI log collection. Each successful check now writes the report and adds it to the checked repository's .gitignore if needed. The report location must be writable. Findings still return exit code 0, and operational errors return 2.

0.0.1

• Initial PyPI release of qubership-envgene-linter.
• Check local instance repositories for placement, naming, secret handling, and reference integrity.
• Print findings in the terminal, with optional HTML output through --html.
• Support rule switches configured when the package is built.