Skip to content

Cap-go/standard-version-for-capacitor

Repository files navigation

@capgo/capacitor-standard-version

Capgo - Instant updates for capacitor

Default config for standard-version in Capacitor apps.

Use it as a built-in replacement for https://www.npmjs.com/package/standard-version.

All config from .versionrc, .versionrc.json, or .versionrc.js is supported.

Install

npm i -D @capgo/capacitor-standard-version

The legacy unscoped package name capacitor-standard-version now lives under the @capgo npm org. The CLI binary name stays capacitor-standard-version.

Usage

Run npx capacitor-standard-version after installing it locally, or npx @capgo/capacitor-standard-version to execute it directly from npm.

For a stable release use npx capacitor-standard-version.

For an alpha prerelease use npx capacitor-standard-version --prerelease alpha.

Example GitHub Action to run it on every commit to main and development.

on:
  push:
    branches:
      - main
      - development

jobs:
  bump-version:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    runs-on: ubuntu-latest
    name: Bump version and create changelog with standard version
    steps:
      - name: Check out
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
          token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
      - name: Git config
        run: |
          git config --local user.name "github-actions[bot]"
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
      - name: Create bump and changelog
        if: github.ref == 'refs/heads/main'
        run: npx @capgo/capacitor-standard-version
      - name: Create bump and changelog
        if: github.ref != 'refs/heads/main'
        run: npx @capgo/capacitor-standard-version --prerelease alpha
      - name: Push to origin
        run: |
          CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
          remote_repo="https://${GITHUB_ACTOR}:${{ secrets.PERSONAL_ACCESS_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
          git pull $remote_repo $CURRENT_BRANCH
          git push $remote_repo HEAD:$CURRENT_BRANCH --follow-tags --tags

For this action to work, store PERSONAL_ACCESS_TOKEN in your repository or organization GitHub Actions Secrets settings and reference it in the workflow as ${{ secrets.PERSONAL_ACCESS_TOKEN }}. You can create the token by following this guide: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token and add it to GitHub Actions Secrets by following this guide: https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions

About

Standard version for Capacitor apps

Topics

Resources

License

Code of conduct

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Sponsor this project

 

Contributors