Skip to content

RELEASING.md

Latest commit

 

History

History
69 lines (46 loc) · 2.45 KB

RELEASING.md

File metadata and controls

69 lines (46 loc) · 2.45 KB
Raw

Release guide

1. Create the GitHub repository

Create an empty public repository named card-stack-android. Do not ask GitHub to generate a README, .gitignore, or license because this source tree already contains them.

Recommended repository metadata:

  • Description: Native Android card stack for Jetpack Compose, derived from leset0ng/card-stack
  • Topics: android, kotlin, jetpack-compose, card-stack, gesture, animation, mit-license
  • Default branch: main
  • License: GitHub should automatically detect MIT from LICENSE

2. Public namespace

The Kotlin package and Android namespace are owned by the repository maintainer:

io.github.defatestar.cardstack

The corresponding identifiers are:

  • Maven groupId: io.github.defatestar
  • Library namespace: io.github.defatestar.cardstack
  • Demo applicationId: io.github.defatestar.cardstack.demo

Changing these identifiers after publication is a breaking public API change. The groupId is reserved in the build metadata, but the README must not claim a Maven dependency coordinate until an artifact repository is configured.

3. Push the source

From the project root:

git init -b main
git add .
git update-index --chmod=+x gradlew
git commit -m "Initial native Android release"
git remote add origin https://github.com/DefateStar/card-stack-android.git
git push -u origin main

Before committing, verify that git status --ignored shows local.properties, build directories, APK/AAR files and signing keys as ignored.

4. Protect the main branch

After the first push, enable a branch ruleset for main:

  • Require a pull request before merging
  • Require the build job from Android CI
  • Block force pushes and branch deletion

The included workflow builds the demo APK and library AAR on pushes and pull requests. Workflow artifacts are temporary test outputs, not permanent public releases.

5. Publish v0.1.0

  1. Confirm CI passes on main.

  2. Create and push the tag:

    git tag -a v0.1.0 -m "Card Stack Android v0.1.0"
git push origin v0.1.0

  3. Create a GitHub Release from v0.1.0.

  4. Attach the tested Demo APK and library AAR.

  5. In the release notes, state that this is an independent native Android port derived from leset0ng/card-stack and licensed under MIT.

Do not upload signing keys or keystore.properties. A public demo APK may use a clearly labeled debug build; production applications should use their own private signing setup.