README.md

cloud-live-update-action

Warning

This GitHub Action is in maintenance mode. We recommend using the Capawesome CLI instead, which offers more flexibility and features. This action will only receive critical bug fixes and security updates going forward.

GitHub Action to deploy a Capacitor Live Update to the Capawesome Cloud.

Usage

- uses: capawesome-team/cloud-live-update-action@v0.0.7
  with:
    # The Capawesome Cloud app ID.
    # Required.
    appId: ''
    # The channel to deploy the update to.
    channel: ''
    # The commit message that the bundle is linked to.'
    commitMessage: ''
    # The commit ref that the bundle is linked to.
    commitRef: ''
    # The commit SHA that the bundle is linked to.
    commitSha: ''
    # The path to the bundle to upload. Must be a folder or zip archive.
    # Required.
    path: ''
    # The Capawesome Cloud API token.
    # Required.
    token: ''

Example

name: Deploy Live Update
on:
  push:
    branches:
      - main
jobs:
  upload-file:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Build web assets
        run: npm run build
      - name: Deploy Live Update
        uses: capawesome-team/cloud-live-update-action@v0.0.7
        id: upload-action
        with:
          appId: 'addb597c-9cbd-4cdc-bcc0-cd5c2234a03f'
          channel: 'production-1.0.0'
          commitMessage: $(git log -1 --pretty=format:"%s")
          commitRef: ${{ github.head_ref || github.ref_name }}
          commitSha: ${{ github.sha }}
          path: 'dist'
          token: ${{ secrets.CAPAWESOME_TOKEN }}

License

See LICENSE.