Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 2.04 KB

README.md

File metadata and controls

57 lines (44 loc) · 2.04 KB
Raw

review-bot-action

GitHub Action for reviewing package control channel changes.

Usage

Note Make sure that the repository that wants to use this action has the Allow GitHub Actions to create and approve pull requests option enabled in repository Settings -> Actions.

Below is an example workflow for running this action. It can be placed at .github/workflows/on-pr.yaml (file can have any name).

name: On PR

# Use of "pull_request_target" rather than "pull_request" event is dictated by the fact that
# pull requests from forks don't have access to the GITHUB_TOKEN secret that is necessary to
# post review comments. "pull_request_target" runs workflow from the main branch instead,
# allowing access token to work. That of course means that workflows changed or added in PRs
# won't have any affect until merged.
on:
  - pull_request_target

jobs:
  trigger-review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
          # Checkout PR branch. By default main repository branch is checked out.
          ref: refs/pull/${{ github.event.pull_request.number }}/merge

      # Ensures that python3-setuptools is installed
      - name: Setup Python
        uses: actions/setup-python@v1
        with:
          python-version: 3.6

      - name: Install Python dependencies
        run: python3 -m pip install pyyaml

      # Run repository unittests
      - uses: packagecontrol/st-schema-reviewer-action@v1

      # Run st package reviewer tests
      - uses: packagecontrol/st-package-reviewer-action@v1
        with:
          pr-url: ${{ github.event.pull_request.url }}
          base-sha: ${{ github.event.pull_request.base.sha }}
          current-sha: ${{ github.event.pull_request.head.sha }}
          token: ${{ secrets.GITHUB_TOKEN }}

Creating releases

When releasing this code action, it's recommended to create releases using semantically versioned tags – for example, v1.1.3 – and keeping major (v1) and minor (v1.1) tags current to the latest appropriate commit.