The BDDVC is a small and fast utility designed to streamline the version control processes for BDD (Behavior-Driven Development) frameworks. It exposes a run method, allowing you to perform various actions related to version control within your BDD project.

To run this project, you will need to add the following environment variables to your .env file

Responsibility	Variable	Example	Default value	Description
Core/MS	BDDVC_GITHUB_TOKEN	ghp_token	—	Token for authentication on Github.
Core/MS/VC	BDDVC_GITHUB_OWNER	organization-name	—	Name of the organization that owns the package (Core/MS/VC)
Core	BDDVC_GITHUB_CORE_REPO	core-repository-name	—	Name of the repository to retrieve release information from Core.
Core	BDDVC_GITHUB_VC_REPO	vc-repository-name	bdd-vc	Name of the repository to retrieve release information from VC.
Core	BDDVC_CORE_PACKAGE_NAME_ALIAS	repository-name-new	BDDVC_GITHUB_CORE_REPO	Alias for the package name, in case it differs from the Github repository name.
Core/MS	BDDVC_ALLOW_PRE_RELEASE	true	false	Allows the use of pre-releases.
Core/MS	BDDVC_SKIP_LIST	["bdd-vc", "repository-name"]	[]	List of packages to skip in the version check(without @organization/).
Core/MS	BDDVC_USE_LOCAL_VERSION_LIST	true	false	Fragment that specifies which config to use (remote or local).

[!IMPORTANT] - this parameter is required!

1. Add the .npmrc file with the following content:

//npm.pkg.github.com/:_authToken=ghp_token
@organization-name:registry=https://npm.pkg.github.com

2. Install

npm i @organization-name/bdd-vc

3. Add the bdd-vc-secrets.env file to root directory with the following content:

BDDVC_GITHUB_TOKEN=ghp_token
BDDVC_GITHUB_OWNER=organization-name
BDDVC_GITHUB_CORE_REPO=core-repository-name
BDDVC_GITHUB_VC_REPO=vc-repository-name
BDDVC_CORE_PACKAGE_NAME_ALIAS=repository-name-new
BDDVC_ALLOW_PRE_RELEASE=true
BDDVC_SKIP_LIST=["bdd-vc", "repository-name"]
BDDVC_USE_LOCAL_VERSION_LIST=false

4. Add the script you need to your package.json:

  "scripts": {
    "check-cv": "env-cmd -f ./bdd-vc-secrets.env check-core-version",
    "check-ms-cv": "env-cmd -f ./bdd-vc-secrets.env check-modular-steps-core-version",
    "remove-ncv": "env-cmd -f ./bdd-vc-secrets.env remove-nested-core-versions"
  },

Important! The env-cmd package must be installed to transfer data from the file to the env environment

5. Launch and enjoy 🐱

[!IMPORTANT] Link is not available inside the bdd-vc package due to a large size of the screenshots in the state documentation

You can always visit BDD-VC package repository

[!NOTE] You can contribute to the development of the package. If you find a bug, create a issue or make an edit yourself, and after checking, create a PR. Good luck.