DEPLOY.md

Steps to deploy

Preparation

1. Execute the script on the test file.

   python configcat-validator.py PKDVCLf-Hq-h-kCzMp-L7Q/NB1-IBFV50erQbSn7DXGIw ./sample_to_scan -v

2. Increase the version in setup.py.
3. Commit & Push

Publish a new docker image and pypi package

Use the same version for the git tag as in the 2. step of the Preparation section.

1. Create a new version tag.

   git tag v[MAJOR].[MINOR].[PATCH]

   Example: git tag v1.2.1

2. Push the tag.

   git push origin --tags

3. Create a new Github release with a new version tag and release notes.

At this point you should have a new docker image and pypi package with the new version you set earlier.

Publish a new CircleCI orb

1. Install the CircleCI CLI.

2. Follow these instructions to configure the CLI.

3. Update the new pypi package and docker image versions in integrations/circleci/orb.yml in lines like: default: 1.1.0.

4. In case of major or minor version number changes update the version references in the examples section accordingly.

5. Validate the orb configuration.

   circleci orb validate integrations/circleci/orb.yml

6. Publish the new orb.

   circleci orb publish integrations/circleci/orb.yml configcat/feature-flag-reference-validator@[MAJOR].[MINOR].[PATCH]

   Example: circleci orb publish integrations/circleci/orb.yml configcat/[email protected]

   You can also publish non-public developer versions with the dev: version prefix like: feature-flag-reference-validator@dev:1.2.1

7. Make sure the new version is available in the Orb Registry.

Test

Use https://github.com/configcat/flag-reference-validator-tester