Skip to content

Commit

Permalink
Validate the whole codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
tylervz committed Feb 29, 2024
1 parent be786d2 commit 63394ba
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/linter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,23 @@ jobs:
uses: super-linter/super-linter/slim@v6
env:
LINTER_RULES_PATH: "."
VALIDATE_ALL_CODEBASE: false
VALIDATE_ALL_CODEBASE: true
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Exclude CHANGELOG.md
FILTER_REGEX_EXCLUDE: (CHANGELOG.md)
# Exclude CHANGELOG.md and other files
FILTER_REGEX_EXCLUDE: "(CHANGELOG.md)|(charts/thub/ci/test-values.yaml)"
VALIDATE_JAVASCRIPT_STANDARD: false
VALIDATE_JSCPD: false
# Kubeconform fails with helm charts
VALIDATE_KUBERNETES_KUBECONFORM: false
VALIDATE_KUBERNETES_KUBEVAL: false
VALIDATE_YAML: false
# Run specific linters and only output warnings. Each linter run here should not be run in the action above.
- name: Lint Code Base for Warnings
uses: super-linter/super-linter/slim@v6
env:
LINTER_RULES_PATH: "."
VALIDATE_ALL_CODEBASE: false
VALIDATE_ALL_CODEBASE: true
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Flag to have the linter complete with exit code 0 even if errors were detected.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# hyperCision Helm Charts

This repo holds Helm charts that we use for deploying our applications. We are using GitHub pages as a means for hosting a Helm chart repository for these charts.
This repository holds Helm charts that we use for deploying our applications. We are using GitHub pages as a means for hosting a Helm chart repository for these charts.

Add the repo as follows:
Add the repository as follows:

```console
helm repo add hypercision https://hypercision.github.io/helm-charts
```

## Developing the Helm charts

Any change to a chart requires a version bump following [semver](https://semver.org/) principles.
Any change to a chart requires a version bump following [SemVer](https://semver.org/) principles.
If you version bump a child chart, you must also version bump the parent chart.
6 changes: 3 additions & 3 deletions charts/thub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ helm uninstall thub

## Developing the Helm charts

Any change to a chart requires a version bump following [semver](https://semver.org/) principles.
Any change to a chart requires a version bump following [SemVer](https://semver.org/) principles.

To see what manifest files would be generated and applied when installing one of our helm charts,
run a command like one of the following in the root directory of the repo:
run a command like one of the following in the root directory of the repository:

```console
helm install --generate-name --dry-run --debug charts/thub -f hclabs-dev.yaml -n hclabs-dev
Expand All @@ -35,7 +35,7 @@ helm install --generate-name --dry-run --debug charts/thub/charts/assigned-item-

Note that you will need to supply a values file for most, if not all, of the charts
since we purposefully do not set default values for things such as passwords and usernames.
You can use the `hclabs-dev.yaml` file found in the [`thub-deploy` repo](https://github.com/hypercision/thub-deploy#helm-values-files)
You can use the `hclabs-dev.yaml` file found in the [`thub-deploy` repository](https://github.com/hypercision/thub-deploy#helm-values-files)
or you could use the [test-values file](/charts/thub/ci/test-values.yaml) we use for testing in our CircleCI pipeline i.e.

```console
Expand Down

0 comments on commit 63394ba

Please sign in to comment.