Allow to define category order/priority

[mvorisek]

This is a feature request to allow to set the category order/priority.

Very important to be able to move more important categories like "Breaking Changes" to the top of the changelog.

[jetersen]

That is done by ordering your categories.

Put the breaking category on top :)

release-drafter/.github/release-drafter.yml

Lines 7 to 19 in 0c70ea3

	categories:
	- title: 'Breaking'
	label: 'type: breaking'
	- title: 'New'
	label: 'type: feature'
	- title: 'Bug Fixes'
	label: 'type: bug'
	- title: 'Maintenance'
	label: 'type: maintenance'
	- title: 'Documentation'
	label: 'type: docs'
	- title: 'Dependency Updates'
	label: 'type: dependencies'

[mvorisek]

That is done by ordering your categories.

Put the breaking category on top :)

That was the first idea that came to my mind, but ir does not work, see:
https://github.com/atk4/data/releases
https://github.com/atk4/data/blob/develop/.github/release-drafter.yml

It seems the uncategorized PRs are moved to the top instead of to the bottom as I would expect

[jetersen]

Yes uncategorized PRs are at the top.
I guess what your asking for is #139

[mvorisek]

Yes, exactly #139 (comment)

Do you think this can be fixed soon and is there currently any workaround like specifying "other/unmatched labels"?

[jetersen]

You know you can just copy and paste? That's a quick workaround 😆

[alfieyfc]

For a workaround that utilizes actions to automate this, I run this job on PR creation:

    steps:
      # Label PR by head branch's name
      - name: Auto Labeler
        uses: TimonVS/pr-labeler-action@v3
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      # Get length of labels array 
      - name: Get Labels
        id: get-label-arr
        run: |
          export LENGTH=$(curl -k https://api.github.com/repos/$GITHUB_REPOSITORY/pulls/${{ github.event.pull_request.number }} | jq '.labels | length')
          echo "::set-output name=length::$(echo $LENGTH)"
      # Label misc if no label was applied
      - name: Label Misc
        if: ${{ steps.get-label-arr.outputs.length == 0 }}
        uses: buildsville/add-remove-label@v1
        with:
          token: ${{secrets.GITHUB_TOKEN}}
          label: "type: misc"
          type: add

and put type: misc in the category at the bottom.

# release-drafter.yml 
categories:
  - title: 🚀 Features
    label: feature
  - title: 🐛 Bug Fixes
    label: fix
  - title: Misc.
    label: "type: misc"
template: |
  $CHANGES

I guess there's a better way to inspect labeled labels than just checking the length of labels array, but this was probably already an overkill for a workaround and it fits my scenario for now so I'm just gonna stick with it 😆

[jetersen]

created #1013

[mvorisek]

thank you ❤️