momocow / semantic-release-gitmoji

โœจ๐Ÿ›๐Ÿ’ฅ A semantic-release plugin for gitmojis. Different from conventional changelog, Gitmoji commits are used to determine a release type and generate release notes.
MIT License
91 stars 20 forks source link

Only default emojis shown on release notes #98

Open Verhaeg opened 8 months ago

Verhaeg commented 8 months ago

If I want to set a different set of emojis and use the default template it "works".. As in it generates the desired version, but the release notes are not generated as intended.

In our case we set several emojis as patch but only the :bug: is shown in the generated release notes.

Taking a quick look at the code, it seems it does not pass the releaseRules config when generating notes.

example config: .releaserc

{
  "branches": [
    "main"
  ],
  "plugins": [
    [
      "semantic-release-gitmoji",
      {
        "releaseRules": {
          "major": [
            "๐Ÿ’ฅ",
            ":boom:"
          ],
          "minor": [
            "โœจ",
            ":sparkles:"
          ],
          "patch": [
            "๐ŸŽจ",
            ":art:",
            "โšก๏ธ",
            ":zap:",
            "๐Ÿ”ฅ",
            ":fire:",
            "๐Ÿ›",
            ":bug:",
            "๐Ÿš‘๏ธ",
            ":ambulance:",
            "๐Ÿ“",
            ":memo:",
            "๐Ÿš€",
            ":rocket:",
            "๐Ÿ’„",
            ":lipstick:",
            "๐ŸŽ‰",
            ":tada:",
            "โœ…",
            ":white_check_mark:",
            "๐Ÿ”’๏ธ",
            ":lock:",
            "๐Ÿ”",
            ":closed_lock_with_key:",
            "๐Ÿ”–",
            ":bookmark:",
            "๐Ÿšจ",
            ":rotating_light:",
            "๐Ÿšง",
            ":construction:",
            "๐Ÿ’š",
            ":green_heart:",
            "โฌ‡๏ธ",
            ":arrow_down:",
            "โฌ†๏ธ",
            ":arrow_up:",
            "๐Ÿ“Œ",
            ":pushpin:",
            "๐Ÿ‘ท",
            ":construction_worker:",
            "๐Ÿ“ˆ",
            ":chart_with_upwards_trend:",
            "โ™ป๏ธ",
            ":recycle:",
            "โž•",
            ":heavy_plus_sign:",
            "โž–",
            ":heavy_minus_sign:",
            "๐Ÿ”ง",
            ":wrench:",
            "๐Ÿ”จ",
            ":hammer:",
            "๐ŸŒ",
            ":globe_with_meridians:",
            "โœ๏ธ",
            ":pencil2:",
            "๐Ÿ’ฉ",
            ":poop:",
            "โช๏ธ",
            ":rewind:",
            "๐Ÿ”€",
            ":twisted_rightwards_arrows:",
            "๐Ÿ“ฆ๏ธ",
            ":package:",
            "๐Ÿ‘ฝ๏ธ",
            ":alien:",
            "๐Ÿšš",
            ":truck:",
            "๐Ÿ“„",
            ":page_facing_up:",
            "๐Ÿฑ",
            ":bento:",
            "โ™ฟ๏ธ",
            ":wheelchair:",
            "๐Ÿ’ก",
            ":bulb:",
            "๐Ÿป",
            ":beers:",
            "๐Ÿ’ฌ",
            ":speech_balloon:",
            "๐Ÿ—ƒ๏ธ",
            ":card_file_box:",
            "๐Ÿ”Š",
            ":loud_sound:",
            "๐Ÿ”‡",
            ":mute:",
            "๐Ÿ‘ฅ",
            ":busts_in_silhouette:",
            "๐Ÿšธ",
            ":children_crossing:",
            "๐Ÿ—๏ธ",
            ":building_construction:",
            "๐Ÿ“ฑ",
            ":iphone:",
            "๐Ÿคก",
            ":clown_face:",
            "๐Ÿฅš",
            ":egg:",
            "๐Ÿ™ˆ",
            ":see_no_evil:",
            "๐Ÿ“ธ",
            ":camera_flash:",
            "โš—๏ธ",
            ":alembic:",
            "๐Ÿ”๏ธ",
            ":mag:",
            "๐Ÿท๏ธ",
            ":label:",
            "๐ŸŒฑ",
            ":seedling:",
            "๐Ÿšฉ",
            ":triangular_flag_on_post:",
            "๐Ÿฅ…",
            ":goal_net:",
            "๐Ÿ’ซ",
            ":dizzy:",
            "๐Ÿ—‘๏ธ",
            ":wastebasket:",
            "๐Ÿ›‚",
            ":passport_control:",
            "๐Ÿฉน",
            ":adhesive_bandage:",
            "๐Ÿง",
            ":monocle_face:",
            "โšฐ๏ธ",
            ":coffin:",
            "๐Ÿงช",
            ":test_tube:",
            "๐Ÿ‘”",
            ":necktie:",
            "๐Ÿฉบ",
            ":stethoscope:",
            "๐Ÿงฑ",
            ":bricks:",
            "๐Ÿง‘โ€๐Ÿ’ป",
            ":technologist:",
            "๐Ÿ’ธ",
            ":money_with_wings:",
            "๐Ÿงต",
            ":thread:"
          ]
        }
      }
    ]
  ]
}
momocow commented 4 months ago

Sorry for late reply, here comes the explanation.

Those "default" emojis to be rendered in the final release notes are defined explicitly in the default template.

Therefore, the default template has nothing to do with the release rules in the current version.

But this behavior can/might be changed in the future version, since you are the second one to ask for the feature.