starred/App-Store-Connect-CLI

Fork 0

mirror of https://github.com/rudrankriyam/App-Store-Connect-CLI.git synced 2026-04-25 15:45:48 +03:00

[GH-ISSUE #711] CI Integrations: publish an official CircleCI Orb for asc #194

New issue

Closed

opened 2026-02-26 21:33:57 +03:00 by kerem · 2 comments

kerem commented

2026-02-26 21:33:57 +03:00

Owner

Originally created by @rudrankriyam on GitHub (Feb 21, 2026).
Original GitHub issue: https://github.com/rudrankriyam/App-Store-Connect-CLI/issues/711

Problem

We have a strong GitHub Actions integration (setup-asc), but CircleCI users still need to hand-roll installation/auth steps for asc in every project.

This creates friction for adoption and makes automation less consistent across teams.

Goal

Publish a first-party CircleCI Orb for asc with production-grade defaults, security handling, and versioned releases.

Research (reference implementations and guidance)

CircleCI Orb authoring guidance

Orb best practices: descriptions for every component, minimal noisy steps, secure secret handling, semver discipline.
- https://circleci.com/docs/orbs/author/orbs-best-practices
Orb creation and publishing workflow (namespace, validate, publish/promote).
- https://circleci.com/docs/orbs/author/create-an-orb
- https://circleci.com/docs/orbs/author/orb-author-validate-publish

High-quality Orb references

circleci/aws-cli orb (install/setup separation, installer robustness, multi-platform script structure).
- https://github.com/CircleCI-Public/aws-cli-orb
circleci/github-cli orb (great pattern for install + setup, token handling via env_var_name, usage examples).
- https://github.com/CircleCI-Public/github-cli-orb
Orb project template + orb-tools publishing pipeline.
- https://github.com/CircleCI-Public/Orb-Template

Proposal (v1 scope)

Create a dedicated orb repo (suggestion: rudrankriyam/asc-orb) and publish as rudrankriyam/asc.

Commands

install
- Installs asc from release assets (versioned) with optional checksum validation.
setup-auth
- Configures environment for asc auth using env var names (not raw secrets in config).
run
- Executes a provided asc command string with optional working directory and output options.

Parameters (minimum)

version (string, default latest)
install_path (string, default /usr/local/bin)
checksum (string, optional)
profile (string, optional)
Secret/env-var-name style params for auth fallback paths (env_var_name where appropriate)
when (on_success/on_fail/always)

Design constraints

Do not hardcode secrets in config.
Use env_var_name for sensitive values to match CircleCI security conventions.
Keep command steps compact and clearly named.
Prefer stable install path defaults, but make path configurable.

Testing & release requirements

Use circleci/orb-tools for lint/pack/review/publish flow.
Add integration test jobs that verify:
- asc --version
- asc --help
- one no-side-effect command path
Publish dev orbs on PRs and production only on semver tags.
Include at least 3 registry examples (install, setup+run, end-to-end workflow usage).

Deliverables

New orb repo with full source (src/@orb.yml, commands, scripts, examples)
CI for orb validation/testing/publishing
Registry publication and docs
README with migration snippets from inline CircleCI steps to orb usage

Acceptance criteria

rudrankriyam/asc orb is publicly discoverable in CircleCI Orb Registry.
install, setup-auth, and run commands work in Linux and macOS CircleCI executors.
Secrets are handled via env-var name patterns and never echoed.
Tagged release (v1.0.0) published with changelog and usage examples.
At least one real project (this repo or a sample repo) consumes the orb successfully.

Nice-to-have follow-ups

Add higher-level jobs (e.g. testflight-release) after core command stability.
Add checksum/signature verification improvements for stricter supply-chain guarantees.

Originally created by @rudrankriyam on GitHub (Feb 21, 2026). Original GitHub issue: https://github.com/rudrankriyam/App-Store-Connect-CLI/issues/711 ## Problem We have a strong GitHub Actions integration (`setup-asc`), but CircleCI users still need to hand-roll installation/auth steps for `asc` in every project. This creates friction for adoption and makes automation less consistent across teams. ## Goal Publish a **first-party CircleCI Orb** for `asc` with production-grade defaults, security handling, and versioned releases. ## Research (reference implementations and guidance) ### CircleCI Orb authoring guidance - Orb best practices: descriptions for every component, minimal noisy steps, secure secret handling, semver discipline. - https://circleci.com/docs/orbs/author/orbs-best-practices - Orb creation and publishing workflow (namespace, validate, publish/promote). - https://circleci.com/docs/orbs/author/create-an-orb - https://circleci.com/docs/orbs/author/orb-author-validate-publish ### High-quality Orb references - `circleci/aws-cli` orb (install/setup separation, installer robustness, multi-platform script structure). - https://github.com/CircleCI-Public/aws-cli-orb - `circleci/github-cli` orb (great pattern for `install` + `setup`, token handling via `env_var_name`, usage examples). - https://github.com/CircleCI-Public/github-cli-orb - Orb project template + orb-tools publishing pipeline. - https://github.com/CircleCI-Public/Orb-Template ## Proposal (v1 scope) Create a dedicated orb repo (suggestion: `rudrankriyam/asc-orb`) and publish as `rudrankriyam/asc`. ### Commands 1. `install` - Installs `asc` from release assets (versioned) with optional checksum validation. 2. `setup-auth` - Configures environment for `asc` auth using env var names (not raw secrets in config). 3. `run` - Executes a provided `asc` command string with optional working directory and output options. ### Parameters (minimum) - `version` (`string`, default `latest`) - `install_path` (`string`, default `/usr/local/bin`) - `checksum` (`string`, optional) - `profile` (`string`, optional) - Secret/env-var-name style params for auth fallback paths (`env_var_name` where appropriate) - `when` (`on_success`/`on_fail`/`always`) ### Design constraints - Do not hardcode secrets in config. - Use `env_var_name` for sensitive values to match CircleCI security conventions. - Keep command steps compact and clearly named. - Prefer stable install path defaults, but make path configurable. ## Testing & release requirements - Use `circleci/orb-tools` for lint/pack/review/publish flow. - Add integration test jobs that verify: - `asc --version` - `asc --help` - one no-side-effect command path - Publish dev orbs on PRs and production only on semver tags. - Include at least 3 registry examples (`install`, `setup+run`, end-to-end workflow usage). ## Deliverables - New orb repo with full source (`src/@orb.yml`, commands, scripts, examples) - CI for orb validation/testing/publishing - Registry publication and docs - README with migration snippets from inline CircleCI steps to orb usage ## Acceptance criteria - `rudrankriyam/asc` orb is publicly discoverable in CircleCI Orb Registry. - `install`, `setup-auth`, and `run` commands work in Linux and macOS CircleCI executors. - Secrets are handled via env-var name patterns and never echoed. - Tagged release (`v1.0.0`) published with changelog and usage examples. - At least one real project (this repo or a sample repo) consumes the orb successfully. ## Nice-to-have follow-ups - Add higher-level jobs (e.g. `testflight-release`) after core command stability. - Add checksum/signature verification improvements for stricter supply-chain guarantees.

kerem

2026-02-26 21:33:57 +03:00

closed this issue
added the
enhancement
label

kerem commented

2026-02-26 21:33:58 +03:00

Author

Owner

@rudrankriyam commented on GitHub (Feb 22, 2026):

Initial CircleCI orb scaffold is now up in a dedicated repository (matching the Bitrise/setup pattern):

Repo: https://github.com/rudrankriyam/asc-orb
Bootstrap PR: https://github.com/rudrankriyam/asc-orb/pull/1

This includes v1 install, setup-auth, and run commands, smoke job/examples, and orb-tools publish workflow wiring.

I am also updating App-Store-Connect-CLI README to add CircleCI orb references.

@rudrankriyam commented on GitHub (Feb 22, 2026): Initial CircleCI orb scaffold is now up in a dedicated repository (matching the Bitrise/setup pattern): - Repo: https://github.com/rudrankriyam/asc-orb - Bootstrap PR: https://github.com/rudrankriyam/asc-orb/pull/1 This includes v1 install, setup-auth, and run commands, smoke job/examples, and orb-tools publish workflow wiring. I am also updating App-Store-Connect-CLI README to add CircleCI orb references.

kerem commented

2026-02-26 21:33:58 +03:00

Author

Owner

@rudrankriyam commented on GitHub (Feb 22, 2026):

Completed.\n\nDelivered artifacts:\n- Dedicated orb repository: https://github.com/rudrankriyam/asc-orb\n- Bootstrap implementation PR (merged): https://github.com/rudrankriyam/asc-orb/pull/1\n- Official metadata/docs/SEO polish PR (merged): https://github.com/rudrankriyam/asc-orb/pull/2\n\nAlso completed companion Bitrise step polish for integration parity:\n- https://github.com/rudrankriyam/steps-setup-asc/pull/1\n\nClosing this issue as done.

@rudrankriyam commented on GitHub (Feb 22, 2026): Completed.\n\nDelivered artifacts:\n- Dedicated orb repository: https://github.com/rudrankriyam/asc-orb\n- Bootstrap implementation PR (merged): https://github.com/rudrankriyam/asc-orb/pull/1\n- Official metadata/docs/SEO polish PR (merged): https://github.com/rudrankriyam/asc-orb/pull/2\n\nAlso completed companion Bitrise step polish for integration parity:\n- https://github.com/rudrankriyam/steps-setup-asc/pull/1\n\nClosing this issue as done.