step.yml

#
# A couple of useful guides & docs:
#
# - Main Bitrise CLI docs: https://github.com/bitrise-io/bitrise/tree/master/_docs
# - Step Development Guideline: https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
# - Bitrise.yml format spec: https://github.com/bitrise-io/bitrise/blob/master/_docs/bitrise-yml-format-spec.md
# - Bitrise docs: http://devcenter.bitrise.io/
# - Bitrise CLI guides: http://devcenter.bitrise.io/bitrise-cli/

title: |-
  Changeset
summary: |
  Run changeset version and publish
description: |
  Run changeset version and publish.
  This step doesn't automatically create PRs, instead it output all required information to create a PR in another step.
website: https://github.com/timostroehlein/bitrise-step-changeset
source_code_url: https://github.com/timostroehlein/bitrise-step-changeset
support_url: https://github.com/timostroehlein/bitrise-step-changeset/issues

# If this step should be available only for certain project types
# just uncomment this `project_type_tags` section and include all the
# project types supported by the step. If the step can be used for all
# project types then you can just remove this section.
# If no `project_type_tags` specified (or specified as an empty array)
# that means the step can be used for any project type.
# You can find more information about project type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
#
# project_type_tags:
#   - ios
#   - macos
#   - android
#   - xamarin
#   - react-native
#   - cordova
#   - ionic
#   - flutter

# Type tags are used for categorizing steps, for easier step discovery in Step Libraries.
# You can find more information about type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
type_tags:
  - utility

# These properties define whether a Step is run in a given Workflow or not.
# You can find more information about this in the documentation here:
# https://devcenter.bitrise.io/en/steps-and-workflows/developing-your-own-bitrise-step/developing-a-new-step.html#setting-conditions-for-running-the-step
#
# is_always_run: false
# is_skippable: false
# run_if: ""

# Use the `deps` property to declare dependencies that you can fetch from an OS dependency manager.
# You can find more information about this in the documentation here:
# https://devcenter.bitrise.io/en/steps-and-workflows/developing-your-own-bitrise-step/developing-a-new-step.html#submodules-and-step-dependencies
#
# deps:
#   brew:
#   - name: cmake
#   apt_get:
#   - name: cmake


toolkit:
  bash:
    entry_file: step.sh


inputs:
  # General
  - commit_hash: $BITRISE_GIT_COMMIT
    opts:
      title: Commit hash
      is_required: true
      is_dont_change_value: true
  - branch: $BITRISE_GIT_BRANCH
    opts:
      title: Current branch
      is_required: true
      is_dont_change_value: true
  - branch_dest: $BITRISEIO_GIT_BRANCH_DEST
    opts:
      title: Branch destination
      summary: Destination branch of the PR, this is usually main
      is_required: true
  # Status inputs
  - run_status: "false"
    opts:
      title: Run changeset status
      summary: Whether to run changeset status
      is_required: true
      value_options: ["true", "false"]
      category: Status
  - status_script:
    opts:
      title: Script
      summary: Custom status script to run, by default changeset status is run
      category: Status
  - status_exists_description:
    opts:
      title: Changeset exists description
      summary: Changeset description used when a changeset has been found
      category: Status
  - status_missing_description:
    opts:
      title: Changeset missing description
      summary: Changeset description used when a changeset is missing
      category: Status
  # Version inputs
  - run_version: "false"
    opts:
      title: Run changeset version
      summary: Whether to run changeset version
      is_required: true
      value_options: ["true", "false"]
      category: Version
  - version_script:
    opts:
      title: Version script
      summary: Custom version script to run, by default changeset version is run
      category: Version
  - install_script:
    opts:
      title: Install script
      summary: Install script of a package manager to update the lock file
      category: Version
  - align_deps_script:
    opts:
      title: Align-deps script
      summary: Align-deps script to generate a new preset and run rnx-align-deps (https://github.com/microsoft/rnx-kit/tree/main/packages/align-deps)
      category: Version
  - align_deps_package_name:
    opts:
      title: Align-deps package name
      summary: Name of the align-deps package within the repo
      category: Version
  - align_deps_min_bump_level: "major"
    opts:
      title: Align-deps min bump level
      summary: Minimum bump level that should trigger the creation of a new align-deps preset
      value_options: ["dep", "patch", "minor", "major"]
      category: Version
  - version_branch: "release/changeset-version"
    opts:
      title: Branch
      summary: Release branch to commit changes to
      category: Version
  - version_commit_message: "changeset version"
    opts:
      title: Commit message
      summary: Version commit message for the changed files
      category: Version
  - version_push_changes: "true"
    opts:
      title: Push changes
      summary: Whether to push version changes to the remote
      is_required: true
      value_options: ["true", "false"]
      category: Version
  - version_pr_title: "Changeset Version"
    opts:
      title: PR title
      summary: Title of the PR
      category: Version
  - version_pr_description:
    opts:
      title: PR description
      summary: Custom description of the PR, this step automatically adds most information to the description
      category: Version
  - version_pr_description_max_length: 32768
    opts:
      title: PR description max length
      summary: Maximum amount of characters allowed in the PR description
      category: Version
  # Publish inputs
  - run_publish: "false"
    opts:
      title: Run changeset publish
      summary: Whether to run changeset publish
      is_required: true
      value_options: ["true", "false"]
      category: Publish
  - publish_script:
    opts:
      title: Publish script
      summary: Publish script to run, by default changeset publish is run
      category: Publish

outputs:
  - CHANGESET_EXISTS:
    opts:
      title: Changeset exists
      summary: Whether any changeset exists
  - CHANGESET_STATUS_DESCRIPTION:
    opts:
      title: Changeset stauts description
      summary: Description of the changeset status
  - CHANGESET_PUBLISHED:
    opts:
      title: Changeset published
      summary: Whether the changeset has been published or not
  - CHANGESET_PR_BRANCH:
    opts:
      title: PR branch
      summary: Source branch to create the PR
  - CHANGESET_PR_TITLE:
    opts:
      title: PR title
      summary: Title which can be used to create a PR
  - CHANGESET_PR_DESCRIPTION:
    opts:
      title: PR description
      summary: Description which can be used to create a PR
  - CHANGESET_RELEASE_CHANGELOG:
    opts:
      title: Release changelog
      summary: Full release changelog, can be used to create a global changelog