Allow multiple exempt labels

[ryanwilsonperkin]

Fixes #17
cc @skjnldsv as requester: Does this match what you were thinking?

Breaking change: This would switch the parameters from:

• exempt-pr-label -> exempt-pr-labels
• exempt-issue-label -> exempt-issue-labels

By switching to a list syntax, we can still support a single "exempt" label (eg. at my company we just have a label called "pinned" that we would use to avoid being marked stale) but can now also support many different "exempt" labels.

Update (13/04/2020):
Because we can't use arrays as arguments to the action, this PR has been switched to use a comma-delimited string to indicate multiple labels.

[ryanwilsonperkin]

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some

[skjnldsv]

Awesome! Yes this is what I have in mind :)

exempt-issue-labels:
  - with team
  - with boss
  - lunch
  - with client

{
	'exempt-issue-labels': [
		'with team',
		'with boss',
		'lunch',
		'with client'
	]
}

[ryanwilsonperkin]

Hey @damccorm thanks again for your help o #11
This PR proposes a breaking change to the interface added in that one, does your team have any opinion on breaking changes in this project?

[Gustry]

Oh yes please, we need this option!
Thanks for the patch.

[LekoArts]

You won't be able to write it like this as an end-user:

exempt-issue-labels:
  - with team
  - with boss
  - lunch
  - with client

Because GitHub doesn't accept that as a valid format.

You can use YAML and the | pipe though like:

exempt-labels: |
  not stale
  important

Then you need to parse the incoming labels:

exemptLabels: parseLabels(core.getInput("exempt-labels"))

To get an array of strings:

// Since GitHub doesn't allow arrays in workflow files
// You need to use YAML and | pipe
// Therefore this function splits on new lines and creates an array
function parseLabels(files: string): string[] {
  return files.split(/\r?\n/).reduce<string[]>(
    (acc, line) =>
      acc
        .concat(line.split(","))
        .filter(pat => pat)
        .map(pat => pat.trim()),
    []
  )
}

---

I used that in our fork: gatsbyjs#1

[ryanwilsonperkin]

@LekoArts thanks for the heads up, I wasn't aware of that limitation. In that case though, I'd probably default to using comma-separated values for the options instead of newline-separated with a pipe operator. I suspect that if we use the pipe operator to put it on multiple lines, users might infer that it's an array and prefix each line with a - which would result in the labels not being applied properly.

So I'd now imagine the default value for this to be the empty string, and the example will give users would be:

exempt-issue-labels: foo,bar,baz

Since this PR has remained un-reviewed for a little while, I'll wait until I've heard back from the owners about whether they'd like to accept this functionality before making the change to the PR.

[qJake]

Looking forward to this in the next release!

I don't think there will be an issue since the actions are versioned, e.g. I reference this action like this:

uses: actions/stale@v1

So as long as this is included in a "v2" for example, it shouldn't break anything existing.

[goanpeca]

In that case though, I'd probably default to using comma-separated

Yes, this seems like a good option since a comma is not a valid character in a label name and would make the parsing much simpler 👍

[dmodoomsirius]

I do hope this becomes a thing soon!!!

[qJake]

Eagerly awaiting this in actions/stale@v2 (or v1.1, or whichever!).

[tbeswick96]

Any eta for this?

[JamesSingleton]

@goanpeca,

Any update on when this would potentially get merged and released?

[goanpeca]

Not my call 🤷‍♂

[JamesSingleton]

@chrispat maybe you can shed some light on this?

[ces131]

Really want to add this to a few repos but can't until multiple exempt labels are added - any updates??

[LekoArts]

As mentioned by me in another PR already: Feel free to use our (Gatsby) fork:
https://github.com/gatsbyjs/stale

[Gustry]

As mentioned by me in another PR already: Feel free to use our (Gatsby) fork:
https://github.com/gatsbyjs/stale

Thanks, I will give it a try!

It's somehow sad that GitHub (which owns this actions repository) doesn't look at PR on their own platforms.

[hross]

This repo is getting pretty stale and I'm taking it over to clean it up and get some of these suggestions merged. I like this one @ryanwilsonperkin if you want to add the comma parsing we can get it merged and pushed with the next release (soon).

And yep @Gustry it's sad this repo got neglected for so long 😢 (but we will rehab it shortly).

[ryanwilsonperkin]

Hey @hross thanks for taking over! I'll push an update to switch this over to comma-parsing instead.

[qJake]

@ryanwilsonperkin Thanks for the quick turnaround!

@hross Thanks for taking this over - really hoping to see a release very soon with this functionality in it! ❤️

[hross]

this looks good if you want to resolve the conflicts I'll merge it.

[ryanwilsonperkin]

On it

[ryanwilsonperkin]

@hross ready 🎉

@hross I notice there's now a dist/index.js file that seems to be the compiled output from TypeScript. Is there some transpile step that I have to run on this PR in order to update that file?

[hross]

@ryanwilsonperkin yes you need to run npm run all (runs linting) or npm run pack to generate the new dist file.

[hross]

(I'll update the readme with better instructions)

[JamesSingleton]

@hross, can't wait for this to go in!