### Tilt Startup Output Example Source: https://kubechecks.readthedocs.io/en/latest/contributing Example output when Tilt starts, showing the web UI address, version, and available interactive commands. ```text Tilt started on http://localhost:10350/ v0.30.13, built 2022-12-05 (space) to open the browser (s) to stream logs (--stream=true) (t) to open legacy terminal mode (--legacy=true) (ctrl-c) to exit ``` -------------------------------- ### Start Tilt Development Environment Source: https://kubechecks.readthedocs.io/en/latest/contributing Run this command from the root directory of the repository to start the Tilt development environment. ```bash tilt up ``` -------------------------------- ### Install and Initialize pass on Linux Source: https://kubechecks.readthedocs.io/en/latest/contributing Install the `pass` password manager on Debian-based, Fedora/RHEL, or Arch Linux systems. Initialize `pass` with your GPG key if you don't have one already. ```bash # Ubuntu/Debian sudo apt install pass # Fedora/RHEL sudo dnf install pass # Arch sudo pacman -S pass # Initialize with your GPG key (one-time setup) gpg --gen-key # if you don't have a GPG key yet pass init "your-email@example.com" ``` -------------------------------- ### Install Kubechecks using Helm Source: https://kubechecks.readthedocs.io/en/latest/usage Install the kubechecks Helm chart into your Kubernetes cluster. Ensure you have configured necessary secrets as per the chart's documentation. ```bash helm install kubechecks charts/kubechecks -n kubechecks --create-namespace ``` -------------------------------- ### Configure .secret file for Fallback Source: https://kubechecks.readthedocs.io/en/latest/contributing Copy the example `.secret` file and edit it with your specific values for backwards compatibility. This file is loaded before keychain values. ```bash cp .secret.example .secret # Edit .secret with your values ``` -------------------------------- ### Add Kubechecks Helm Repository Source: https://kubechecks.readthedocs.io/en/latest/usage Add the kubechecks Helm chart repository to your Helm configuration. This is a prerequisite for installing kubechecks. ```bash helm repo add kubechecks https://zapier.github.io/kubechecks/ ``` -------------------------------- ### Configure Tilt VCS Type Source: https://kubechecks.readthedocs.io/en/latest/contributing Set the `vcs-type` in `tilt_config.json` to specify the version control system. The default is `gitlab`, but this example configures it for `github`. ```json { "vcs-type": "github" } ``` -------------------------------- ### Serve Documentation Locally with MkDocs Source: https://kubechecks.readthedocs.io/en/latest/contributing Build and serve the project's documentation locally using MkDocs. Changes will auto-reload, and docs are viewable at http://localhost:8000. ```bash mkdocs serve ``` -------------------------------- ### Run All CI Checks with Make Source: https://kubechecks.readthedocs.io/en/latest/contributing Execute all continuous integration checks, including code formatting, golangci-lint, and tests, using the `make ci` command. ```bash make ci ``` -------------------------------- ### Run Individual CI Checks with Make Source: https://kubechecks.readthedocs.io/en/latest/contributing Run specific CI checks individually using Make targets. Available checks include tests, linting, formatting, and validation. ```bash make test # Run all tests make lint # Run golangci-lint (includes go vet) make fmt # Check code formatting make validate # Run go vet (also included in lint) ``` -------------------------------- ### Store Secrets with pass on Linux Source: https://kubechecks.readthedocs.io/en/latest/contributing Store secrets using the `pass` command-line utility. This includes required tokens like GITLAB_TOKEN or GITHUB_TOKEN, and optional secrets. ```bash # Required: one of GITLAB_TOKEN or GITHUB_TOKEN pass insert kubechecks/GITLAB_TOKEN # or pass insert kubechecks/GITHUB_TOKEN # Optional pass insert kubechecks/KUBECHECKS_WEBHOOK_SECRET pass insert kubechecks/OPENAI_API_TOKEN pass insert kubechecks/ANTHROPIC_API_KEY ``` -------------------------------- ### Verify Secret Storage with pass Source: https://kubechecks.readthedocs.io/en/latest/contributing Check if a secret has been successfully stored using the `pass` command. ```bash pass kubechecks/GITLAB_TOKEN ``` -------------------------------- ### Local Docker Maintenance Commands Source: https://kubechecks.readthedocs.io/en/latest/contributing Clean up dangling Docker images and build cache using `docker image prune` and `docker buildx prune`. ```bash docker image prune # Remove dangling images docker buildx prune # Remove build cache ``` -------------------------------- ### Sign Git Commit with DCO Source: https://kubechecks.readthedocs.io/en/latest/contributing Append a trailer to sign off on a commit using the Developer Certificate of Origin. Use `-s` or `--signoff` when committing. ```bash git commit -s ``` -------------------------------- ### Find Generic Password in macOS Keychain Source: https://kubechecks.readthedocs.io/en/latest/contributing Verify if a secret is stored in your macOS Keychain using this command. ```bash security find-generic-password -a "$USER" -s "kubechecks/GITLAB_TOKEN" -w ``` -------------------------------- ### Add Secret to macOS Keychain Source: https://kubechecks.readthedocs.io/en/latest/contributing Store secrets like Gitlab or Github tokens in the macOS keychain using the `security` command. Use `-w` with no value to be prompted interactively. ```bash security add-generic-password -a "$USER" -s "kubechecks/GITLAB_TOKEN" -w ``` ```bash security add-generic-password -a "$USER" -s "kubechecks/GITHUB_TOKEN" -w ``` -------------------------------- ### Add Generic Password to macOS Keychain Source: https://kubechecks.readthedocs.io/en/latest/contributing Use this command to add a new generic password to your macOS Keychain. Omit the value to be prompted for it. The `-U` flag updates an existing secret. ```bash security add-generic-password -a "$USER" -s "kubechecks/KUBECHECKS_WEBHOOK_SECRET" -w security add-generic-password -a "$USER" -s "kubechecks/OPENAI_API_TOKEN" -w security add-generic-password -a "$USER" -s "kubechecks/ANTHROPIC_API_KEY" -w ``` ```bash security add-generic-password -a "$USER" -s "kubechecks/GITLAB_TOKEN" -U -w ``` -------------------------------- ### Amend Last Commit with DCO Source: https://kubechecks.readthedocs.io/en/latest/contributing If you forget to sign off on your last commit, amend it using `git commit --amend --signoff`. For multiple commits, use `git rebase --signoff HEAD~N`. ```bash git commit --amend --signoff ``` ```bash git rebase --signoff HEAD~2 ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.