starred/App-Store-Connect-CLI
1
0
Fork 0
mirror of https://github.com/rudrankriyam/App-Store-Connect-CLI.git synced 2026-04-25 15:45:48 +03:00
Code Issues 2 Projects Releases 10 Packages Wiki Activity

[GH-ISSUE #714] Templates: add official GitHub workflow templates + Swift starter repository template for asc #198

New issue
Closed
opened 2026-02-26 21:33:58 +03:00 by kerem · 0 comments
kerem commented 2026-02-26 21:33:58 +03:00
Owner
Copy link

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

Problem

We already have setup-asc for GitHub Actions, but developers still start from scratch when setting up release automation in new repos.

This slows adoption and causes inconsistent CI/CD patterns across projects.

Goal

Ship official GitHub templates in two forms:

  1. Organization workflow templates (visible in “Actions → New workflow”).
  2. A Swift/iOS repository template (visible via “Use this template”).

Both should promote asc as the default release automation path.

Research (authoritative references)

Workflow templates (organization-level)

Starter quality references (iOS/Swift)

Repository templates

Proposal

Part A — Organization workflow templates

Create/use rudrankriyam/.github (public) and add:

.github/
  workflow-templates/
    asc-ios-build-test.yml
    asc-ios-build-test.properties.json
    asc-testflight-release.yml
    asc-testflight-release.properties.json
    asc-appstore-submit.yml
    asc-appstore-submit.properties.json
    asc.svg

Template set (v1)

  1. asc-ios-build-test.yml
    • Build/test on macOS
    • Optional artifact export
  2. asc-testflight-release.yml
    • Build/archive + upload/distribute via asc
  3. asc-appstore-submit.yml
    • Submission flow with guarded/manual triggers

Metadata requirements (*.properties.json)

  • name and description required
  • use iconName (custom SVG in workflow-templates/)
  • add categories aligned to Swift/CI/Deployment
  • add filePatterns to suggest templates in iOS/Swift repos (*.xcodeproj, *.xcworkspace, Package.swift)

Part B — Swift/iOS repository template

Create a new repository template (suggestion: rudrankriyam/ios-asc-template) containing:

.github/workflows/
  ci.yml
  release-testflight.yml
  submit-appstore.yml
.asc/
  workflow.json
App/ (or SampleApp/)
README.md
LICENSE

Template goals

  • Zero-to-ship bootstrap for Swift/iOS repos
  • clear secret/env setup docs
  • setup-asc pre-wired in workflows
  • safe defaults (manual dispatch for release/submit jobs)

Design constraints

  • Keep release workflows non-destructive by default unless explicit input/approval is provided.
  • Do not hardcode secrets; rely on GitHub encrypted secrets/env vars.
  • Ensure generated workflows are readable and easy to customize.

Deliverables

  1. rudrankriyam/.github workflow templates + metadata + icon.
  2. ios-asc-template repository marked as Template Repository.
  3. Documentation pages:
    • “Use asc workflow templates in your org”
    • “Create a new iOS repo from template and ship with asc”

Acceptance criteria

  • Templates appear in Actions → New workflow for org repos.
  • Each workflow template validates and runs in a sample iOS repo.
  • ios-asc-template appears with Use this template and boots a working pipeline.
  • README includes copy/paste quick-start for required secrets and first release run.
  • No Git LFS artifacts in template repo.

Nice-to-have follow-ups

  • Add variants for macOS-only app pipelines.
  • Add an “agent mode” template optimized for JSON outputs and machine-readable artifacts.
  • Add badge/snippet generator for README inclusion after template creation.
Originally created by @rudrankriyam on GitHub (Feb 21, 2026). Original GitHub issue: https://github.com/rudrankriyam/App-Store-Connect-CLI/issues/714 ## Problem We already have `setup-asc` for GitHub Actions, but developers still start from scratch when setting up release automation in new repos. This slows adoption and causes inconsistent CI/CD patterns across projects. ## Goal Ship official **GitHub templates** in two forms: 1. **Organization workflow templates** (visible in “Actions → New workflow”). 2. **A Swift/iOS repository template** (visible via “Use this template”). Both should promote `asc` as the default release automation path. ## Research (authoritative references) ### Workflow templates (organization-level) - GitHub workflow template docs (required `workflow-templates/` structure, `.properties.json` metadata, `$default-branch` placeholder): - https://docs.github.com/en/actions/how-tos/reuse-automations/create-workflow-templates - Workflow template usage and starter workflow behavior: - https://docs.github.com/en/actions/writing-workflows/using-workflow-templates - https://docs.github.com/en/actions/learn-github-actions/using-starter-workflows ### Starter quality references (iOS/Swift) - Official starter workflows for iOS and Swift: - https://github.com/actions/starter-workflows/blob/main/ci/ios.yml - https://github.com/actions/starter-workflows/blob/main/ci/swift.yml ### Repository templates - GitHub template repository behavior and constraints (optionally include all branches, no Git LFS in template repo): - https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository ## Proposal ### Part A — Organization workflow templates Create/use `rudrankriyam/.github` (public) and add: ```text .github/ workflow-templates/ asc-ios-build-test.yml asc-ios-build-test.properties.json asc-testflight-release.yml asc-testflight-release.properties.json asc-appstore-submit.yml asc-appstore-submit.properties.json asc.svg ``` #### Template set (v1) 1. **`asc-ios-build-test.yml`** - Build/test on macOS - Optional artifact export 2. **`asc-testflight-release.yml`** - Build/archive + upload/distribute via `asc` 3. **`asc-appstore-submit.yml`** - Submission flow with guarded/manual triggers #### Metadata requirements (`*.properties.json`) - `name` and `description` required - use `iconName` (custom SVG in `workflow-templates/`) - add `categories` aligned to Swift/CI/Deployment - add `filePatterns` to suggest templates in iOS/Swift repos (`*.xcodeproj`, `*.xcworkspace`, `Package.swift`) ### Part B — Swift/iOS repository template Create a new repository template (suggestion: `rudrankriyam/ios-asc-template`) containing: ```text .github/workflows/ ci.yml release-testflight.yml submit-appstore.yml .asc/ workflow.json App/ (or SampleApp/) README.md LICENSE ``` #### Template goals - Zero-to-ship bootstrap for Swift/iOS repos - clear secret/env setup docs - `setup-asc` pre-wired in workflows - safe defaults (manual dispatch for release/submit jobs) ## Design constraints - Keep release workflows non-destructive by default unless explicit input/approval is provided. - Do not hardcode secrets; rely on GitHub encrypted secrets/env vars. - Ensure generated workflows are readable and easy to customize. ## Deliverables 1. `rudrankriyam/.github` workflow templates + metadata + icon. 2. `ios-asc-template` repository marked as Template Repository. 3. Documentation pages: - “Use asc workflow templates in your org” - “Create a new iOS repo from template and ship with asc” ## Acceptance criteria - Templates appear in **Actions → New workflow** for org repos. - Each workflow template validates and runs in a sample iOS repo. - `ios-asc-template` appears with **Use this template** and boots a working pipeline. - README includes copy/paste quick-start for required secrets and first release run. - No Git LFS artifacts in template repo. ## Nice-to-have follow-ups - Add variants for macOS-only app pipelines. - Add an “agent mode” template optimized for JSON outputs and machine-readable artifacts. - Add badge/snippet generator for README inclusion after template creation.
kerem 2026-02-26 21:33:58 +03:00
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
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#198
No description provided.