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: |-
  Comment on GitHub Pull Request
summary: |
  Comment on [GitHub](https://github.com) Pull Request or Issue
description: |
  You can send a comment on [GitHub](https://github.com) Pull Request or Issue.

  To setup a **GitHub personal access token** visit: https://github.com/settings/tokens
website: https://github.com/kvvzr/bitrise-step-comment-on-github-pull-request
source_code_url: https://github.com/kvvzr/bitrise-step-comment-on-github-pull-request
support_url: https://github.com/kvvzr/bitrise-step-comment-on-github-pull-request/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04

# 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

# 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:
  - notification

is_requires_admin_user: true
is_always_run: true
is_skippable: false
run_if: ""

toolkit:
  go:
    package_name: github.com/kvvzr/bitrise-step-comment-on-github-pull-request


inputs:
  - personal_access_token:
    opts:
      title: "GitHub personal access token"
      description: |
        To setup a **GitHub personal access token** visit: https://github.com/settings/tokens
        Add repo(Full control of private repositories) scope to the generated token, to allow to comment on GitHub Pull Request or Issue.
      is_required: true
      is_sensitive: true
  - body:
    opts:
      title: "Body"
      description: |
        Text of the message to send.
      is_required: true
  - repository_url: "$GIT_REPOSITORY_URL"
    opts:
      title: "Repository URL"
      description: |
        The URL for target GitHub Repository.
      is_required: true
  - issue_number: "$BITRISE_PULL_REQUEST"
    opts:
      title: "GitHub PullRequest or Issue number"
      description: |
        Number of GitHub Pull request or Issue.
      is_required: true
  - api_base_url: "https://api.github.com"
    opts:
      title: "GitHub API Base URL"
      description: |-
        The URL for GitHub or GitHub Enterprise API
      is_required: true