Add comment on PRs in CI environments

[EnricoVacondio]

closes #1057

As described in the issue #1057 the comments aren't added in CI environment.
Here is a simple fix for it.

I was trying to understand why they weren't enabled but actually I do not see any reason.

[webpro]

Thanks @EnricoVacondio! Personally I rarely use release-it from CI, so didn't bother to add this yet. Any chance you could add a test or somehow show me this actually works in CI?

[EnricoVacondio]

@webpro Sure!
Here is the workflow that I used to test:

name: Release
run-name: 🚀 Release

on:
  push:
    branches:
      - main

permissions:
  contents: write
  pull-requests: write

jobs:
  release-it:
    name: Release it
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Github config
        run: |
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git config user.name "github-actions[bot]"

      - name: Install
        run: |
          yarn install

      - name: Release
        run: |
          yarn release-it --verbose
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

with the following configuration

git:
  commitMessage: "[skip ci] chore: release v${version}"
  tagName: "v${version}"
  addUntrackedFiles: true
npm:
  publish: false
github:
  release: true
  releaseName: "Release v${version}"
  comments:
    submit: true
    issue: ":rocket: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"
    pr: ":rocket: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"
plugins:
  "@release-it/conventional-changelog":
    preset: "angular"
    infile: "CHANGELOG.md"

The output is:

I also tested the default behaviour and of course the comments are not posted on PRs.
Let me know if you need more info.

[webpro]

🚀 This pull request is included in v17.1.0. See Release 17.1.0 for release notes.

[webpro]

Thanks again @EnricoVacondio!