Failed cs_tools git deploy on Github Action

[kaypro4]

Hello, I'm getting this error when executing a git deploy via a Github action.

The installed version is 1.5.10.

This was running well as of Oct 1st without any changes to the pipeline code. The error seems to point to an issue with the env vars but no changes have been made there. I copy/pasted the secret key just in case.

Any leads on what could be tripping this up?

Thanks
Matt

Error

2024-10-22T00:38:33.8010395Z ##[group]Run cs_tools tools git branches deploy --org $CS_TOOLS_ORG --branch-name stage --deploy-type FULL --tags source-deployed --config ENV: 2024-10-22T00:38:33.8011850Z �[36;1mcs_tools tools git branches deploy --org $CS_TOOLS_ORG --branch-name stage --deploy-type FULL --tags source-deployed --config ENV:�[0m 2024-10-22T00:38:33.8071203Z shell: /usr/bin/bash -e {0} 2024-10-22T00:38:33.8071809Z env: 2024-10-22T00:38:33.8072388Z CS_TOOLS_THOUGHTSPOT__URL: https://fairtradeusa-dev.thoughtspot.cloud 2024-10-22T00:38:33.8073093Z CS_TOOLS_THOUGHTSPOT__USERNAME: ci-cd-dev 2024-10-22T00:38:33.8073837Z CS_TOOLS_THOUGHTSPOT__SECRET_KEY: *** 2024-10-22T00:38:33.8074252Z CS_TOOLS_ORG: 1146874994 2024-10-22T00:38:33.8074781Z pythonLocation: /opt/hostedtoolcache/Python/3.12.7/x64 2024-10-22T00:38:33.8075411Z PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.12.7/x64/lib/pkgconfig 2024-10-22T00:38:33.8076049Z Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.7/x64 2024-10-22T00:38:33.8076654Z Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.7/x64 2024-10-22T00:38:33.8077315Z Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.7/x64 2024-10-22T00:38:33.8077989Z LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.12.7/x64/lib 2024-10-22T00:38:33.8078503Z ##[endgroup] 2024-10-22T00:38:35.4582963Z ╭───────────────────── Traceback (most recent call last) ──────────────────────╮ 2024-10-22T00:38:35.4592520Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/cs_tool │ 2024-10-22T00:38:35.4594255Z │ s/cli/commands/main.py:100 in run │ 2024-10-22T00:38:35.4595464Z │ │ 2024-10-22T00:38:35.4596675Z │ 97 │ _setup_logging() │ 2024-10-22T00:38:35.4598116Z │ 98 │ │ 2024-10-22T00:38:35.4599273Z │ 99 │ try: │ 2024-10-22T00:38:35.4600562Z │ ❱ 100 │ │ return_code = app(standalone_mode=False) │ 2024-10-22T00:38:35.4602149Z │ 101 │ │ return_code = 0 if return_code is None else return_code │ 2024-10-22T00:38:35.4603332Z │ 102 │ │ 2024-10-22T00:38:35.4604714Z │ 103 │ except (click.exceptions.Abort, click.exceptions.Exit, typer.Abort │ 2024-10-22T00:38:35.4605900Z │ │ 2024-10-22T00:38:35.4607083Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/typer/m │ 2024-10-22T00:38:35.4608648Z │ ain.py:338 in __call__ │ 2024-10-22T00:38:35.4609762Z │ │ 2024-10-22T00:38:35.4610934Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/typer/m │ 2024-10-22T00:38:35.4612492Z │ ain.py:321 in __call__ │ 2024-10-22T00:38:35.4613605Z │ │ 2024-10-22T00:38:35.4614813Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/click/c │ 2024-10-22T00:38:35.4616297Z │ ore.py:1157 in __call__ │ 2024-10-22T00:38:35.4617979Z │ │ 2024-10-22T00:38:35.4619313Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/typer/c │ 2024-10-22T00:38:35.4620885Z │ ore.py:728 in main │ 2024-10-22T00:38:35.4621993Z │ │ 2024-10-22T00:38:35.4623132Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/typer/c │ 2024-10-22T00:38:35.4624958Z │ ore.py:197 in _main │ 2024-10-22T00:38:35.4626588Z │ │ 2024-10-22T00:38:35.4627821Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/click/c │ 2024-10-22T00:38:35.4629373Z │ ore.py:1688 in invoke │ 2024-10-22T00:38:35.4630573Z │ │ 2024-10-22T00:38:35.4631876Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/click/c │ 2024-10-22T00:38:35.4633459Z │ ore.py:1688 in invoke │ 2024-10-22T00:38:35.4634583Z │ │ 2024-10-22T00:38:35.4635746Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/click/c │ 2024-10-22T00:38:35.4637276Z │ ore.py:1688 in invoke │ 2024-10-22T00:38:35.4638331Z │ │ 2024-10-22T00:38:35.4639549Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/click/c │ 2024-10-22T00:38:35.4640803Z │ ore.py:1688 in invoke │ 2024-10-22T00:38:35.4641886Z │ │ 2024-10-22T00:38:35.4643184Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/cs_tool │ 2024-10-22T00:38:35.4644506Z │ s/cli/ux.py:36 in invoke │ 2024-10-22T00:38:35.4645516Z │ │ 2024-10-22T00:38:35.4646683Z │ 33 │ │ """Hi-jack command execution to fire off dependencies.""" │ 2024-10-22T00:38:35.4647951Z │ 34 │ │ with contextlib.ExitStack() as stack: │ 2024-10-22T00:38:35.4649196Z │ 35 │ │ │ for dependency in self.dependencies: │ 2024-10-22T00:38:35.4650445Z │ ❱ 36 │ │ │ │ stack.enter_context(dependency(ctx)) │ 2024-10-22T00:38:35.4651543Z │ 37 │ │ │ │ 2024-10-22T00:38:35.4652733Z │ 38 │ │ │ r = ctx.invoke(self.callback, **ctx.params) │ 2024-10-22T00:38:35.4654085Z │ 39 │ 2024-10-22T00:38:35.4655036Z │ │ 2024-10-22T00:38:35.4656226Z │ /opt/hostedtoolcache/Python/3.12.7/x64/lib/python3.12/contextlib.py:526 in │ 2024-10-22T00:38:35.4657643Z │ enter_context │ 2024-10-22T00:38:35.4658701Z │ │ 2024-10-22T00:38:35.4659910Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/cs_tool │ 2024-10-22T00:38:35.4661434Z │ s/cli/dependencies/thoughtspot.py:121 in __enter__ │ 2024-10-22T00:38:35.4662651Z │ │ 2024-10-22T00:38:35.4664922Z │ 118 │ │ if overrides: │ 2024-10-22T00:38:35.4666685Z │ 119 │ │ │ log.debug(f"Command Overrides: {' '.join(overrides)}") │ 2024-10-22T00:38:35.4667795Z │ 120 │ │ │ 2024-10-22T00:38:35.4668945Z │ ❱ 121 │ │ cfg = CSToolsConfig.from_name(config, **overrides, automigrate │ 2024-10-22T00:38:35.4670258Z │ 122 │ │ │ 2024-10-22T00:38:35.4671375Z │ 123 │ │ if cfg.verbose: │ 2024-10-22T00:38:35.4672666Z │ 124 │ │ │ root = logging.getLogger() │ 2024-10-22T00:38:35.4674080Z │ │ 2024-10-22T00:38:35.4675280Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/cs_tool │ 2024-10-22T00:38:35.4676770Z │ s/settings.py:347 in from_name │ 2024-10-22T00:38:35.4677946Z │ │ 2024-10-22T00:38:35.4679013Z │ 344 │ │ """Read in a config by its name, typically performed on the CL │ 2024-10-22T00:38:35.4680383Z │ 345 │ │ if name.upper().startswith("ENV:"): │ 2024-10-22T00:38:35.4681631Z │ 346 │ │ │ name, _, dotfile = name.partition(":") │ 2024-10-22T00:38:35.4682860Z │ ❱ 347 │ │ │ return cls.from_environment(name=name, dotfile=dotfile or │ 2024-10-22T00:38:35.4684067Z │ 348 │ │ │ 2024-10-22T00:38:35.4685246Z │ 349 │ │ conf = cls.from_toml(cs_tools_venv.app_dir / f"cluster-cfg_{na │ 2024-10-22T00:38:35.4686374Z │ 350 │ 2024-10-22T00:38:35.4687501Z │ │ 2024-10-22T00:38:35.4688670Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/cs_tool │ 2024-10-22T00:38:35.4690030Z │ s/settings.py:370 in from_environment │ 2024-10-22T00:38:35.4691286Z │ │ 2024-10-22T00:38:35.4692375Z │ 367 │ │ if dotfile is not None: │ 2024-10-22T00:38:35.4693602Z │ 368 │ │ │ config["_env_file"] = pathlib.Path(dotfile).as_posix() │ 2024-10-22T00:38:35.4694771Z │ 369 │ │ │ 2024-10-22T00:38:35.4695898Z │ ❱ 370 │ │ return cls.model_validate(config) │ 2024-10-22T00:38:35.4697062Z │ 371 │ │ 2024-10-22T00:38:35.4698276Z │ 372 │ @classmethod │ 2024-10-22T00:38:35.4699471Z │ 373 │ def from_toml(cls, path: pathlib.Path, automigrate: bool = False) │ 2024-10-22T00:38:35.4700900Z │ │ 2024-10-22T00:38:35.4702241Z │ /home/runner/.config/cs_tools/.cs_tools/lib/python3.12/site-packages/pydanti │ 2024-10-22T00:38:35.4703852Z │ c/main.py:596 in model_validate │ 2024-10-22T00:38:35.4704972Z │ │ 2024-10-22T00:38:35.4706082Z │ 593 │ │ """ │ 2024-10-22T00:38:35.4707241Z │ 594 │ │ # __tracebackhide__ tells pytest and some other tools to om │ 2024-10-22T00:38:35.4708624Z │ 595 │ │ __tracebackhide__ = True │ 2024-10-22T00:38:35.4709887Z │ ❱ 596 │ │ return cls.__pydantic_validator__.validate_python( │ 2024-10-22T00:38:35.4711117Z │ 597 │ │ │ obj, strict=strict, from_attributes=from_attributes, cont │ 2024-10-22T00:38:35.4712411Z │ 598 │ │ ) │ 2024-10-22T00:38:35.4713450Z │ 599 │ 2024-10-22T00:38:35.4714608Z ╰──────────────────────────────────────────────────────────────────────────────╯ 2024-10-22T00:38:35.4715877Z ValidationError: 1 validation error for CSToolsConfig 2024-10-22T00:38:35.4717063Z thoughtspot 2024-10-22T00:38:35.4718331Z Field required [type=missing, input_value={'name': 'ENV'}, input_type=dict] 2024-10-22T00:38:35.4720079Z For further information visit https://errors.pydantic.dev/2.9/v/missing 2024-10-22T00:38:35.4720847Z 2024-10-22T00:38:35.4720859Z 2024-10-22T00:38:35.4721502Z ╭──────────────────── 🤓 This is an unhandled error! 🤓 ─────────────────────╮ 2024-10-22T00:38:35.4722515Z │ │ 2024-10-22T00:38:35.4723890Z │ If you encounter this message more than once, please help by letting us │ 2024-10-22T00:38:35.4725114Z │ know! │ 2024-10-22T00:38:35.4726076Z │ │ 2024-10-22T00:38:35.4727317Z │ GitHub: https://github.com/thoughtspot/cs_tools/issues/new/choose │ 2024-10-22T00:38:35.4728422Z │ │ 2024-10-22T00:38:35.4729610Z ╰──────────── Run cs_tools logs report to send us your last error. ────────────╯ 2024-10-22T00:38:35.4730446Z 2024-10-22T00:38:35.4730458Z 2024-10-22T00:38:39.7311031Z ##[error]Process completed with exit code 1.

Full github actions yaml in case it's useful

`
name: Deploy to Environment

on:
push:
branches:
- stage
- main

jobs:
deploy:
runs-on: ubuntu-latest
environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'stage' }}

env:
  # Using vars and secrets for environment-specific configuration
  CS_TOOLS_THOUGHTSPOT__URL: ${{ vars.TS_ORG_URL }}
  CS_TOOLS_THOUGHTSPOT__USERNAME: ${{ vars.TS_ORG_USERNAME }}
  CS_TOOLS_THOUGHTSPOT__SECRET_KEY: ${{ secrets.TS_ORG_SECRET_KEY }}
  CS_TOOLS_ORG: ${{ vars.TS_ORG_ID }} 

steps:
  # Checkout the repository to access the files
  - name: Checkout repository
    uses: actions/checkout@v3

  # Set up Python 3.12
  - name: Set up Python 3.12
    uses: actions/setup-python@v4
    with:
      python-version: 3.12

  # Install a specific version of CS Tools
  - name: Install CS Tools
    run: |
      curl \
        --silent --show-error --location-trusted \
        https://raw.githubusercontent.com/thoughtspot/cs_tools/v1.5.9/cs_tools/updater/_bootstrapper.py \
        | python3 - --install

  # Add CS Tools to the PATH
  - name: Add CS Tools to PATH
    run: echo "${HOME}/.config/cs_tools/.cs_tools/bin" >> $GITHUB_PATH

  # Verify CS Tools installation
  - name: Check CS Tools Version
    run: cs_tools --version
    
  # Run the CS Tools deploy command using environment variables for authentication
  - name: Deploy using CS Tools
    run: |
      cs_tools tools git branches deploy --org $CS_TOOLS_ORG --branch-name ${{ github.ref == 'refs/heads/main' && 'main' || 'stage' }} --deploy-type FULL --tags source-deployed --config ENV:

`

[boonhapus]

@kaypro4 This is due to pydantic_settings == 2.6.0 changing their API and leading to quite a few issues.

I haven't had time to debug it fully yet and switch to their recommended approaches, but you can swap your install lines in your workflow file for these...

  # Restrict pydantic-settings
  - name: Install Pydantic-Setting requirements
    run: python -m pip install pydantic-settings==2.5.2

  # Install a specific version of CS Tools
  - name: Install CS Tools
    run: python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v1.5.10.zip"

and unblock the issue I believe.

[kaypro4]

Thanks for the quick help @boonhapus ! I applied your changes verbatim and that solved it.

[boonhapus]

FYI @kaypro4 - pydantic-settings released 2.6.1 which reverts some changes that were causing this issue recently. Even my own CI is suddenly working again.. just had to ignore the problem for long enough 🤪