feat: Allow enum options to be newline delimited only

[jszwedko]

Fixes: #204

Signed-off-by: Jesse Szwedko jesse@szwedko.me

[amannn]

Thank you for your PR! I see your point and I'd be open to require newlines generally (not configurable).

Would you want to change this PR according to this and make sure the docs point the user towards that?

It will be a new major version then.

[jszwedko]

Thanks for the feedback @amannn ! I pushed another commit that removes the backwards compatibility and requires lists to be newline delimited. Let me know what you think.

[amannn]

Does it make sense to support \r here too? https://stackoverflow.com/questions/1761051/difference-between-n-and-r

[jszwedko]

I don't think it makes sense since \r, by itself, is just a carriage return rather than a newline. For Windows file editing, it'd typically have \r\n which would still be split, and then subsequently trimmed, correctly. I'll push a change to add \r\n to the test.

[amannn]

Sounds fair, thank you for your feedback!

[jszwedko]

Thanks for the feedback @amannn ! I push a few more changes.

[github-actions]

🎉 This PR is included in version 5.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[ab-arao]

This change did break our workflows because we have the following steps in github actions:

1. determine valid scopes based on the file changed in the pull request
2. pass those scopes to action-semantic-pull-request
3. run action-semantic-pull-request using those scopes

We had been completing step 1 using a bash array and using $GITHUB_OUTPUT to pass the scopes as a space delimited string to step 3.

Below is how we are now implementing this in case anyone is in a similar situation.

jobs:
  validate-semantic-pull-request:
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v4
      - name: Identify valid scopes
        id: scope-identifier
        run: |
          declare -a scopes=()

          // logic to figure out the valid scopes

          var=$( IFS=$'\n'; echo "${scopes[*]}" )

          echo 'scopes<<EOF' >> "$GITHUB_OUTPUT"
          echo "$var" >> "$GITHUB_OUTPUT"
          echo 'EOF' >> "$GITHUB_OUTPUT"
      - uses: amannn/action-semantic-pull-request@v5.3.0
        if: ${{ steps.scope-identifier.outputs.scopes }} != ""
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          scopes: |
            ${{ steps.scope-identifier.outputs.scopes }}
          requireScope: true

This solution was largely based on github/docs#21529.