feat: Add possibility to provide onSuccess function

[BeyondEvil]

This adds two new options:

• onSuccessFunction
• onFailFunction

Both functions takes pluginConfig and context as arguments so that the user has access to all the Semantic Release configuration. They also take precedence over the respective template option (we can change this of course, I don't have a strong opinion either way).

Before I add documentation and tests, I just want to make sure we're fine with this type of addition. @juliuscc @hannesrabo cc: @AndrewLeedham (it was your idea after all)

See also #39 and #26

Example config (tested, but with irrelevant parts removed)

const slackifyMarkdown = require('slackify-markdown')
const { chunkifyString } = require('semantic-release-slack-bot/lib/chunkifier')

const onSuccessFunction = (pluginConfig, context) => {
  const releaseNotes = slackifyMarkdown(context.nextRelease.notes)
  const text = `Updates to ${pluginConfig.packageName} has been released to *Stage!*`
  const headerBlock = {
    type: 'section',
    text: {
      type: 'mrkdwn',
      text,
    },
  }

  return {
    text,
    blocks: [
      headerBlock,
      ...chunkifyString(releaseNotes, 2900).map(chunk => {
        return {
          type: 'section',
          text: {
            type: 'mrkdwn',
            text: chunk,
          },
        }
      })
    ],
  }
}

module.exports = {
  branches: "master",
  preset: 'eslint',
  plugins: [
    [
      'semantic-release-slack-bot',
      {
        notifyOnSuccess: true,
        onSuccessFunction,
        packageName: 'Testing Semantic Release',
      },
    ],
  ],
}

[AndrewLeedham]

@BeyondEvil makes sense to me 👍

[juliuscc]

I like this concept! Could you add the example (or a similar one) to the docs?

[juliuscc]

What does this do? Is this used somewhere or is it meant to be imported by our users?

[BeyondEvil]

It's called here.

I figured the logic deserved it's own function. For readability, extendability, and usability. :)

[juliuscc]

what does this line do?

[BeyondEvil]

I should probably explain the algorithm "inline". I'll add that when I add docs and tests.

But basically we have messageLines which is an array of all the text split newline (\n) and we have the maxLength which is the size of each message chunk

So for each item in messageLines we test if adding a new chunk will put us over the limit (maxLength). If it does we "reset" message with this new chunk (line 10).

If it doesn't put us over, we keep concatenating the chunks to message.

Hope that makes sense! 😂 @juliuscc

[BeyondEvil]

I like this concept! Could you add the example (or a similar one) to the docs?

I take that as I should add docs and tests and turn this into a proper PR. 😊

[BeyondEvil]

Some tests added. Will add more tests and docs tomorrow.

[juliuscc]

I like this concept! Could you add the example (or a similar one) to the docs?

I take that as I should add docs and tests and turn this into a proper PR. 😊

Haha yes! I later saw that there wasn't any doc-updates 😁

I think the concept is great! 👍

[BeyondEvil]

That's it for tests.

I'll try and add docs tomorrow.

I named the test-files according to convention. Will rename the other test-files in a separate PR.

[BeyondEvil]

I'd say this is ready for review now @juliuscc @hannesrabo @AndrewLeedham 😊

[BeyondEvil]

Not sure if this is actually true? 🤔

[juliuscc]

Hmm, I can not think of a way to make it work otherwise. Let's keep it like that unless someone corrects us 😁

[juliuscc]

Great that you have cleaned up in the Readme! I didn't know that there were that many spelling mistakes 😅

[juliuscc]

This all looks great to me! 👍

[juliuscc]

Thanks for the hard work! @BeyondEvil 🥇

[juliuscc]

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀