Skip to content

Latest commit

 

History

History
82 lines (74 loc) · 2.51 KB

README.md

File metadata and controls

82 lines (74 loc) · 2.51 KB
Raw

Main releases

To enable app releases you need to add .github/workflows/release.yml file into your app repository.

name: Supervisely release
run-name: Supervisely ${{ github.repository }} app release
on:
  release:
    types: [published]
    branches:
      - main
      - master
jobs:
  Supervisely-Release:
    uses: supervisely-ecosystem/workflows/.github/workflows/common.yml@master
    secrets:
      SUPERVISELY_API_TOKEN: "${{ secrets.SUPERVISELY_PROD_API_TOKEN }}"
      GH_ACCESS_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
    with:
      SUPERVISELY_SERVER_ADDRESS: "${{ vars.SUPERVISELY_PROD_SERVER_ADDRESS }}"
      SLUG: "${{ github.repository }}"
      RELEASE_VERSION: "${{ github.event.release.tag_name }}"
      RELEASE_TITLE: "${{ github.event.release.name }}"
      IGNORE_SLY_RELEASES: 1
      RELEASE_WITH_SLUG: 1
      CHECK_PREV_RELEASES: 1
      SUBAPP_PATHS: "__ROOT_APP__, subapp"

SUBAPP_PATHS - list of subapp paths, separated by comma. If you don't have subapps, just leave __ROOT_APP__. examples:

  1. Subapps located in /train and /serve folders
SUBAPP_PATHS: "train, serve"
  1. Main app only
SUBAPP_PATHS: "__ROOT_APP__"

Branch releases

To enable branch app releases you need to add .github/workflows/release_dev.yml file into your app repository. Each time there is a push to a branch, a new release with release version and release name equal to the branch name will be created.

name: Supervisely release
run-name: Supervisely ${{ github.repository }} app release
on:
  push:
    branches-ignore:
      - main
      - master
jobs:
  Supervisely-Release:
    uses: supervisely-ecosystem/workflows/.github/workflows/common.yml@master
    secrets:
      SUPERVISELY_API_TOKEN: "${{ secrets.SUPERVISELY_PROD_API_TOKEN }}"
      GH_ACCESS_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
    with:
      SUPERVISELY_SERVER_ADDRESS: "${{ vars.SUPERVISELY_PROD_SERVER_ADDRESS }}"
      SLUG: "${{ github.repository }}"
      RELEASE_VERSION: "${{ github.ref_name }}"
      RELEASE_TITLE: "${{ github.ref_name }} branch release"
      IGNORE_SLY_RELEASES: 1
      RELEASE_WITH_SLUG: 1
      CHECK_PREV_RELEASES: 0
      SUBAPP_PATHS: "__ROOT_APP__, subapp"

SUBAPP_PATHS - list of subapp paths, separated by comma. If you don't have subapps, just leave __ROOT_APP__. examples:

  1. Subapps located in /train and /serve folders
SUBAPP_PATHS: "train, serve"
  1. Main app only
SUBAPP_PATHS: "__ROOT_APP__"