Skip to content

GitHub Action: azure/setup-cosmosdb-shell for CI workflows #178

Open

Description

Feedback source

External user feedback (travel multi-agent workshop team).

Problem

There is no official GitHub Action to install/setup CosmosDB Shell in CI workflows. Users must manually download, extract, and add to PATH — adding boilerplate and fragility to every workflow.

Proposed solution

Publish an official azure/setup-cosmosdb-shell GitHub Action that:

  • Accepts a version input (with a sensible default/latest)
  • Downloads the correct platform-specific package
  • Extracts and adds to PATH
  • Caches the binary across runs (using actions/cache or tool-cache)
  • Verifies checksum/signature

Example usage

steps:
  - uses: azure/setup-cosmosdb-shell@v1
    with:
      version: 1.0.213-preview
```n
## Acceptance criteria
- [ ] Action published to GitHub Marketplace
- [ ] Supports Linux, macOS, Windows runners
- [ ] Built-in caching (tool-cache pattern)
- [ ] Version pinning and 'latest' support
- [ ] Documented in CI/CD guide

Activity

  1. mkrueger commented on Jul 16, 2026

    @mkrueger
    Collaborator

    Thats usually what "dotnet tool install CosmosDBShell" is there fore - that allows easy installation of the cosmos shell everywhere so manual "dl/extract/add to path" is not true - dotnet install is the most usual way of installing/updating the shell atm.

    If we decide a dedicated github action may worth it I need a new repo: azure/setup-cosmosdb-shell

    action.yml need to be in repository root there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1automationAutomation & CI ergonomics

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions