https://github.com/armakuni/circleci-context-validator
Circleci Context Validation in Code
https://github.com/armakuni/circleci-context-validator
circleci cli documentation infrastructure validation
Last synced: 5 months ago
JSON representation
Circleci Context Validation in Code
- Host: GitHub
- URL: https://github.com/armakuni/circleci-context-validator
- Owner: armakuni
- License: cc0-1.0
- Created: 2022-01-14T10:17:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T17:02:31.000Z (over 1 year ago)
- Last Synced: 2025-09-08T14:58:11.901Z (10 months ago)
- Topics: circleci, cli, documentation, infrastructure, validation
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@armakuni/circleci-context-validator
- Size: 1.02 MB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
CircleCI Context Validator CLI Tool
=================
[](https://circleci.com/gh/armakuni/circleci-context-validator/tree/main)
* [Purpose](#purpose)
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Commands](#commands)
* [Example](#examples)
* [Dev Mode](#development)
* [Upcoming & WIP](#upcoming)
# Purpose
As projects grow, team members drop in and out and the documented state of environment variables become a mystery, and left in a precarious state not knowing if a varaible is required any more looking at the Circle UI.
CircleCI Context Validator (*CCV for short*) makes use of a simple yaml configuration file, [refer to the example](./example/context_validator.yml). The configuration file refers to the names of the context and associated environment variables. The config should reflect what should only be present in your context (can be more than one, should you need that), is then compared against the API giving back user input on valid or failures.
# Prerequisites
- [CircleCI using Contexts](https://circleci.com/docs/2.0/contexts/)
- A CircleCI Organization ID
- NOTE: Retrieve ID at the following https://app.circleci.com/settings/organization/github/YOUR_ORG_NAME_HERE/overview
- [CircleCI Personal API Token](https://app.circleci.com/settings/user/tokens)
- NOTE: [Managing API Tokens](https://circleci.com/docs/2.0/managing-api-tokens/)
# Install
```sh-session
$ npm install -g @armakuni/circleci-context-validator
```
or
```sh-session
$ yarn global add @armakuni/circleci-context-validator
```
# Commands
```
$ ccv (--version)
@armakuni/circleci-context-validator/ darwin-x64 node-v16.13.1
$ ccv --help [COMMAND]
USAGE
$ CIRCLECI_PERSONAL_ACCESS_TOKEN=example-token ccv circleci validate --context-definitions example/context_validator.yml
```
```
USAGE
$ ccv help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for ccv.
```
# Examples
Run the CLI tool:
```sh
CIRCLECI_PERSONAL_ACCESS_TOKEN=example-token ccv circleci validate --context-definitions .circleci/context_validator.yml
```
## All Valid
Context exists, associated env var values configured exist in context definition yaml.
```
Context "context-validator-ci" is valid
Success
```
## Missing Env Var
Configured in context definition yaml, but not present in CircleCI Context
```
Missing Env Var "API_KEY" in Context "context-validator-ci"
Failures 1
```
## Missing Context
Configured in context definition yaml, but not present in CircleCI Context
```
Context "context-validator-cid" is missing
Failures 1
```
## Undocumented
A value is not configured, but exists in circleci
```
Unexpected Env Var "NPM_TOKEN" in Context "context-validator-ci"
Failures 1
```
# Development
How to dev on `circleci-context-validator`, for a quick start guide checkout [oclif](https://oclif.io) which this tool makes heavy use of.
## Entrypoint
Command entrypoint is located: `circleci-context-validator/src/commands/circleci/validate`
## NVM
```
$ cd circleci-context-validator
$ nvm use .
```
## Dev Run (no compile)
```sh-session
CIRCLECI_PERSONAL_ACCESS_TOKEN=generate_personal_access_token bin/dev circleci validate --context-definitions example/context_validator.yml
```
# Upcoming
- Pretty console output
- Different output formats e.g. JSON
- Support for standard Environment Variables i.e. non-context associated
- Autocomplete commands
- Retrieve existing context and associated env vars to pre-populate a context_validator.yml