[GH-ISSUE #485] Pre-submission guardrails: add asc validate for metadata, assets, required fields, and age-rating completeness #136

New issue

Closed

opened 2026-02-26 21:33:42 +03:00 by kerem · 3 comments

kerem commented 2026-02-26 21:33:42 +03:00

Owner

Copy link

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

Summary

Add a new asc validate command that performs client-side release-readiness checks before submission.

Why this matters

Teams commonly run lightweight metadata checks before upload/submit to catch preventable failures early.
Today, validation is split across commands and misses a single pre-submission gate.

Proposed command

asc validate --app "APP_ID" --version-id "VERSION_ID"
asc validate --app "APP_ID" --version-id "VERSION_ID" --platform IOS --output table
asc validate --app "APP_ID" --version-id "VERSION_ID" --strict

Checks in scope (phase 1)

1. Metadata length limits
   • description, keywords, release notes, promotional text, name, subtitle
2. Required field presence
   • required localizations and mandatory text fields for the target version
3. Screenshot validity
   • screenshot dimensions/type compatibility (using the screenshot size catalog)
4. Age-rating completeness
   • required declaration attributes present and internally consistent

Current state (verified)

• migrate validate has offline character-limit checks, but only for imported local files.
• Submission flow (internal/cli/submit/submit.go) does not run a holistic pre-submission validator.
• Age-rating data and screenshot data are available through existing ASC client methods.

Output model

Return structured check results with severity:

• error: blocks submission
• warning: non-blocking
• info: informational

JSON shape should include:

• summary counts
• per-check identifiers
• field/resource references
• remediation hints

Detailed implementation plan

• Create new command package: internal/cli/validate/ with validate.go + commands.go.
• Register in internal/cli/registry/registry.go.
• Add validation engine package (e.g. internal/validation/) for reusable rules.
• Move shared metadata limit constants out of migrate-only scope so both commands reuse one source of truth.
• Add fetch layer to gather required inputs (version localizations, app info localizations, screenshot sets/assets, age rating declaration).
• Implement rule modules:
  • metadata lengths
  • required fields
  • screenshot dimensions
  • age-rating completeness
• Add --strict behavior to elevate warnings to errors for CI use.
• Add cmdtests + rule unit tests covering pass/fail edge cases.
• Document usage in README.md and submission workflow docs.

Acceptance criteria

• asc validate exists as a top-level command and supports JSON/table/markdown output.
• Command exits non-zero when validation errors are present.
• Validation output contains actionable remediation hints.
• Rules cover metadata limits, required fields, screenshot dimensions, and age-rating completeness.
• make test passes with full coverage for validator behavior.

Originally created by @rudrankriyam on GitHub (Feb 10, 2026). Original GitHub issue: https://github.com/rudrankriyam/App-Store-Connect-CLI/issues/485 ## Summary Add a new `asc validate` command that performs client-side release-readiness checks before submission. ## Why this matters Teams commonly run lightweight metadata checks before upload/submit to catch preventable failures early. Today, validation is split across commands and misses a single pre-submission gate. ## Proposed command ```bash asc validate --app "APP_ID" --version-id "VERSION_ID" asc validate --app "APP_ID" --version-id "VERSION_ID" --platform IOS --output table asc validate --app "APP_ID" --version-id "VERSION_ID" --strict ``` ## Checks in scope (phase 1) 1. Metadata length limits - description, keywords, release notes, promotional text, name, subtitle 2. Required field presence - required localizations and mandatory text fields for the target version 3. Screenshot validity - screenshot dimensions/type compatibility (using the screenshot size catalog) 4. Age-rating completeness - required declaration attributes present and internally consistent ## Current state (verified) - `migrate validate` has offline character-limit checks, but only for imported local files. - Submission flow (`internal/cli/submit/submit.go`) does not run a holistic pre-submission validator. - Age-rating data and screenshot data are available through existing ASC client methods. ## Output model Return structured check results with severity: - `error`: blocks submission - `warning`: non-blocking - `info`: informational JSON shape should include: - summary counts - per-check identifiers - field/resource references - remediation hints ## Detailed implementation plan - [ ] Create new command package: `internal/cli/validate/` with `validate.go` + `commands.go`. - [ ] Register in `internal/cli/registry/registry.go`. - [ ] Add validation engine package (e.g. `internal/validation/`) for reusable rules. - [ ] Move shared metadata limit constants out of migrate-only scope so both commands reuse one source of truth. - [ ] Add fetch layer to gather required inputs (version localizations, app info localizations, screenshot sets/assets, age rating declaration). - [ ] Implement rule modules: - [ ] metadata lengths - [ ] required fields - [ ] screenshot dimensions - [ ] age-rating completeness - [ ] Add `--strict` behavior to elevate warnings to errors for CI use. - [ ] Add cmdtests + rule unit tests covering pass/fail edge cases. - [ ] Document usage in `README.md` and submission workflow docs. ## Acceptance criteria - [ ] `asc validate` exists as a top-level command and supports JSON/table/markdown output. - [ ] Command exits non-zero when validation errors are present. - [ ] Validation output contains actionable remediation hints. - [ ] Rules cover metadata limits, required fields, screenshot dimensions, and age-rating completeness. - [ ] `make test` passes with full coverage for validator behavior.

kerem 2026-02-26 21:33:42 +03:00

• closed this issue
• added the
  enhancement
  label

kerem commented 2026-02-26 21:33:43 +03:00

Author

Owner

Copy link

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

@cursor Please implement this issue end-to-end.

What to build

Add top-level asc validate command for pre-submission client-side checks across metadata, required fields, screenshot compatibility, and age-rating completeness.

Implementation plan

1. Command scaffolding

• Add internal/cli/validate/ package with validate.go + commands.go.
• Register in internal/cli/registry/registry.go.
• Support standard output flags (--output, --pretty) and strict mode.

2. Validation engine

• Add reusable rules package (e.g. internal/validation/).
• Rule groups:
  • metadata length limits
  • required-field presence
  • screenshot dimension/type compatibility
  • age-rating completeness/consistency

3. Data collection layer

• Fetch required resources using existing ASC client methods (version localizations, app info localizations, screenshot sets/assets, age rating declarations).
• Build a unified validation report with severity + remediation hints.

4. Exit behavior

• Non-zero exit when errors exist.
• --strict escalates warnings to blocking behavior for CI.

New tests to write

A) Rule unit tests (internal/validation)

• metadata over-limit/valid cases
• required-field missing/present
• screenshot mismatch/pass
• age-rating incomplete/complete

B) CLI cmdtests (internal/cli/cmdtest)

• missing required args -> usage error
• report rendering in JSON/table
• strict-mode exit behavior
• mixed warning/error scenarios

C) Regression coverage

• ensure existing migrate validate behavior remains unchanged
• shared metadata limits stay consistent across commands

How to test locally

Run exactly:

• make format
• make lint
• make test

Targeted tests:

• go test ./internal/validation -run 'Metadata|Required|Screenshot|AgeRating'
• go test ./internal/cli/cmdtest -run 'validate'

Done criteria

• asc validate is available and documented.
• Output includes actionable per-check details and summary counts.
• Exit codes support CI gating (--strict included).
• Coverage exists for each rule group.
• All checks pass (format, lint, test).

<!-- gh-comment-id:3881459102 --> @rudrankriyam commented on GitHub (Feb 11, 2026): @cursor Please implement this issue end-to-end. ## What to build Add top-level `asc validate` command for pre-submission client-side checks across metadata, required fields, screenshot compatibility, and age-rating completeness. ## Implementation plan 1. **Command scaffolding** - Add `internal/cli/validate/` package with `validate.go` + `commands.go`. - Register in `internal/cli/registry/registry.go`. - Support standard output flags (`--output`, `--pretty`) and strict mode. 2. **Validation engine** - Add reusable rules package (e.g. `internal/validation/`). - Rule groups: - metadata length limits - required-field presence - screenshot dimension/type compatibility - age-rating completeness/consistency 3. **Data collection layer** - Fetch required resources using existing ASC client methods (version localizations, app info localizations, screenshot sets/assets, age rating declarations). - Build a unified validation report with severity + remediation hints. 4. **Exit behavior** - Non-zero exit when errors exist. - `--strict` escalates warnings to blocking behavior for CI. ## New tests to write ### A) Rule unit tests (`internal/validation`) - metadata over-limit/valid cases - required-field missing/present - screenshot mismatch/pass - age-rating incomplete/complete ### B) CLI cmdtests (`internal/cli/cmdtest`) - missing required args -> usage error - report rendering in JSON/table - strict-mode exit behavior - mixed warning/error scenarios ### C) Regression coverage - ensure existing migrate validate behavior remains unchanged - shared metadata limits stay consistent across commands ## How to test locally Run exactly: - `make format` - `make lint` - `make test` Targeted tests: - `go test ./internal/validation -run 'Metadata|Required|Screenshot|AgeRating'` - `go test ./internal/cli/cmdtest -run 'validate'` ## Done criteria - `asc validate` is available and documented. - Output includes actionable per-check details and summary counts. - Exit codes support CI gating (`--strict` included). - Coverage exists for each rule group. - All checks pass (`format`, `lint`, `test`).

kerem commented 2026-02-26 21:33:43 +03:00

Author

Owner

Copy link

@cursor[bot] commented on GitHub (Feb 11, 2026):

• I added a new top-level asc validate command with a reusable internal/validation engine that checks metadata length limits, required fields/locales, screenshot size compatibility, and age-rating completeness, plus --strict CI gating and table/markdown output registration. I also moved metadata limit constants into the shared validation package so migrate and validate use the same source of truth.
• I wired the command into the registry, added report/table rendering, and updated the README with usage/examples; I also introduced a test-only ASC client constructor to support cmdtests.

Tests run:

• go test ./internal/validation -run 'Metadata|Required|Screenshot|AgeRating'
• go test ./internal/cli/cmdtest -run 'validate' (no tests matched due to case sensitivity)
• go test ./internal/cli/cmdtest -run 'Validate'
• make tools (to install gofumpt/golangci-lint), then make format
• make lint
• make test

 

<!-- gh-comment-id:3881459405 --> @cursor[bot] commented on GitHub (Feb 11, 2026): - I added a new top-level `asc validate` command with a reusable `internal/validation` engine that checks metadata length limits, required fields/locales, screenshot size compatibility, and age-rating completeness, plus `--strict` CI gating and table/markdown output registration. I also moved metadata limit constants into the shared validation package so migrate and validate use the same source of truth. - I wired the command into the registry, added report/table rendering, and updated the README with usage/examples; I also introduced a test-only ASC client constructor to support cmdtests. Tests run: - `go test ./internal/validation -run 'Metadata|Required|Screenshot|AgeRating'` - `go test ./internal/cli/cmdtest -run 'validate'` (no tests matched due to case sensitivity) - `go test ./internal/cli/cmdtest -run 'Validate'` - `make tools` (to install gofumpt/golangci-lint), then `make format` - `make lint` - `make test` <p><a href="https://github.com/rudrankriyam/App-Store-Connect-CLI/pull/492"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/view-pr-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/view-pr-light.png"><img alt="View PR" width="86" height="28" src="https://cursor.com/assets/images/view-pr-light.png"></picture></a></p> <p><a href="https://cursor.com/background-agent?bcId=bc-fab7d7e8-15bb-46f4-8180-f622e47039aa"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img alt="Open in Cursor" width="131" height="28" src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;<a href="https://cursor.com/agents?id=bc-fab7d7e8-15bb-46f4-8180-f622e47039aa"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a></p>

kerem commented 2026-02-26 21:33:43 +03:00

Author

Owner

Copy link

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

Resolved by PR #492 (https://github.com/rudrankriyam/App-Store-Connect-CLI/pull/492), which is merged into main.

<!-- gh-comment-id:3887482346 --> @rudrankriyam commented on GitHub (Feb 11, 2026): Resolved by PR #492 (https://github.com/rudrankriyam/App-Store-Connect-CLI/pull/492), which is merged into main.

kerem referenced this issue 2026-02-26 21:34:33 +03:00

[PR #136] [MERGED] Fix users command: required name flags for invite, role filter for list #317

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.1

1.0.0

0.49.1

0.49.0

0.48.1

0.48.0

0.47.1

0.47.0

0.46.2

0.46.1

0.46.0

0.45.4

0.45.3

0.45.2

0.45.1

0.45.0

0.44.2

0.44.1

0.44.0

0.43.0

0.42.0

0.41.4

0.41.3

0.41.2

0.41.1

0.41.0

0.40.1

0.40.0

0.39.1

0.39.0

0.38.3

0.38.2

0.38.1

0.38.0

0.37.3

0.37.2

0.37.1

0.37.0

0.36.3

0.36.2

0.36.1

0.36.0

0.35.3

0.35.2

0.35.1

0.35.0

0.34.1

0.34.0

0.33.2

0.33.1

0.33.0

0.32.0

0.31.3

0.31.2

0.31.1

0.31.0

0.30.0

0.29.3

0.29.2

0.29.1

0.29.0

0.28.14

0.28.13

0.28.12

0.28.11

0.28.10

0.28.9

0.28.8

0.28.7

0.28.6

0.28.5

0.28.4

0.28.3

0.28.2

0.28.1

0.28.0

0.27.0

0.26.4

0.26.3

0.26.2

0.26.1

0.26.0

0.25.4

0.25.3

0.25.1

0.25.0

0.24.3

0.24.2

0.24.1

0.24.0

0.23.5

0.23.4

0.23.3

0.23.2

0.23.1

0.23.0

0.22.1

0.22.0

0.21.0

0.20.2

0.20.1

0.20.0

0.19.3

0.19.2

0.19.1

0.19.0

0.18.2

0.18.1

0.18.0

0.17.0

0.16.0

0.15.0

0.14.0

0.13.0

0.12.4

0.12.3

0.12.2

0.12.1

0.12.0

0.11.0

0.10.2

0.10.1

0.10.0

0.9.0

0.8.1

0.8.0

0.7.0

0.6.0

0.5.0

0.3.1

0.3.0

0.2.0

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Labels

Clear labels   

bug

  

bug

  

documentation

  

enhancement

  

pull-request

Mirrored from GitHub Pull Request

No labels

bug

bug

documentation

enhancement

pull-request

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/App-Store-Connect-CLI#136

No description provided.