Skip to content

Latest commit

 

History

History
179 lines (93 loc) · 13.2 KB

CHANGELOG.md

File metadata and controls

179 lines (93 loc) · 13.2 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2.7.1 - 2024-11-07

Fixed

  • 2024-11-07 - [#51] - be8ccfe Fixed the issue when selecting a common commit the reference doesn't appear in the commit message. The reference prompt will now appear after selecting a common commit for you to double check that the auto-detected reference is correct before commiting.

2.7.0 - 2024-11-07

Added

  • 2024-11-07 - [#50] - f51ccf9 User can use the setting commonCommits to add an array of commonly used commit messages which will appear when running the extension.

2.6.0 - 2024-09-25

Added

  • 2024-09-25 - 1b5a208 User can add a config file to their project called .commitbuilderrc.json which will change their Conventional Commit Builder settings without having to set them in their user/vscode settings.

2.5.0 - 2024-07-01

Added

  • 2024-07-01 - 5725c1b User can add their own custom types which will then appear in the types prompt.

2.4.2 - 2024-06-21

Added

  • 2024-06-21 - e2c93be Updated extension commands to make the name of the extension.

2.4.1 - 2024-06-21

Added

  • 2024-06-21 - bd3b20d Updated README.md.

2.4.0 - 2024-06-21

Fixed

  • 2024-06-21 - [#42] - 068dd71 Fixes the issue where if you don't have any transformation functions within your template, your commit message will be blank.

2.3.0 - 2023-12-25

Added

  • 2023-12-25 - #41 - db03e94 User can wrap a prompt step in the template setting with a function, for example, Uppercase() leading to the text entered into the wrapped prompt to be converted into all capital letters in the commit message.

Fixed

  • 2023-12-22 - #37 - 8c47066 Fixed issue where new lines were remaining if body and footer was skipped. Leading to trailing new lines.

  • 2023-12-22 - #39 - a38f757 Fixed issue where only the first newLine value was being converted to a new line and didn't convert newLine's that weren't surrounded by spaces.

2.2.0 - 2023-12-22

Added

  • 2023-09-14 - #34 - 1271c25 User can change what they deem to be a new line within the template. This allows for custom new line, by default \n in the template will be replaced with a new line. The user can set this in their settings.json like so, "conventionalCommitBuilder.newLine": "CustomNewLine", this will replace the any CustomNewLine within the message string with a new line.

  • 2023-08-20 - #32 - c77e5e5 When this is set to false, the commit message create won't get automatically committed. This, when paired with showCommit, allows the user to double check their message before committing. The user can set this in their settings.json like so, "conventionalCommitBuilder.autoCommit": false.

  • 2023-08-20 - #31 - fadfef1 This change shows the commit message created by the prompts in the SCM tab's input box. The user can set this in their settings.json like so, "conventionalCommitBuilder.showCommit": true.

  • 2023-08-13 - #30 - 9ae6c15 The user now has the option to hide any prompt. The user can set this in their settings.json like so, "conventionalCommitBuilder.disableDescription": true, this will stop the Description prompt from showing.

2.1.0 - 2023-08-11

Added

  • 2023-08-11 - #29 - bcbc35f The user can now choose whether they want to filter the list of emojis using the emojis description or code. The user can set this in their settings.json like so, "conventionalCommitBuilder.emojiFilter": "code".

2.0.0 - 2023-08-10

Added

  • bcbc35f Issue has been renamed to Reference. This will cause conventionalCommitBuilder.template and conventionalCommitBuilder.issueRegex to break. For conventionalCommitBuilder.template, <number> will need renaming to <reference>. For conventionalCommitBuilder.issueRegex, it will need to be renamed to conventionalCommitBuilder.referenceRegex.

1.5.0 - 2023-08-09

Added

  • #23 - e957a26 The user can now add conventionalCommitBuilder.disableEmoji to their settings file and the emoji prompt will be skipped. This means that the final commit message won't include an emoji.

1.4.0 - 2023-07-19

Fixed

  • #21 - fe05388 Fixed issue #20 where only Modified files were showing in the Changes to Stage prompt. Now all file within your Source Control tree will show.

1.3.0 - 2023-06-04

Added

  • #16 - c474726 These changes allow the extension to remember what the user previously entered. Example, if they entered a description then went to the next step, then went back to edit the description, the user wouldn't have to remember what they previously entered to edit it. The previously entered description will already be pre-populated within the description prompt.

1.2.0 - 2023-04-10

Added

  • #13 - 92983e9 If the default RegEx doesn't detect your issue then you can define a custom RegEx in the settings.json called "conventionalCommitBuilder.issueRegex". Your custom RegEx will then the be used instead of the default one to detect your issue/ticket number. NOTE: If you want to include a backslash \, in your RegEx, for example: \w+, then you will need to escape the backslash as it is an escape character itself it so wont make it through the conversion to RegEx. For example, \w+ should be typed as \\w+.

1.1.0 - 2023-04-06

Added

  • #11 - 41c7afc If you haven't staged any changes a prompt will ask you to select files to stage. Before Conventional Commit Builder asks you for your commit details it will ask you to chose changes to stage then once you have chosen it will continue with the rest of the prompts.

1.0.1 - 2023-04-06

  • 3c806ae - Renamed SVG's to simple-commit-light and simple-commit-dark.
  • 7e4e367 - Added more keywords and categories to help the extension get discovered.

1.0.0 - 2023-04-06

Added

  • #10 - d5dc03a The back button on prompts will take you to the previous step. The step order is now determined on your template. For example, the default template is <type><scope>: <emoji> <number> - <description>\n\n<body>\n\n<footer> so you will see the <type> prompt, then the <scope> prompt and so on, but if your conventionalCommitBuilder.template was set to <emoji> <number> <type><scope>... then the first prompt will be the <emoji>, second will be <number> prompt and so.

0.4.0 - 2023-04-05

Changed

  • 67d1818 Renamed schema to template. This change means that conventionalCommitBuilder.schema will have to be renamed to conventionalCommitBuilder.template in your settings.json file.

0.3.0 - 2023-04-04

Added

  • 4cee90a Changed the prompts for vscode.window.showInputBox() to custom input box using vscode.window.createInputBox(). Which will allow better keyboard functionality.

[0.2.0] - 2023-04-04

Added

  • #5 - 6d69a2e Issue/Ticket number prompt will now be pre-populated with your issue/ticket number which is detects from your branch name.
  • #6 - be9095e Ability to define a commit schema which the extension uses to build your commit message and put things like the topic, emoji and scope in the places of the commit message you want them to be.

Fixed

  • 2cd30f4 Selecting emoji will put the emoji code into your commit message instead of just the emoji name.

[0.1.0] - 2023-03-31

Added

  • gitmoji's
  • Conventional Commit Builder icon within the Source Control tab.

[0.0.3] - 2023-03-31

Added

  • Changed the prompts for vscode.window.showQuickPick() to custom quick pick using vscode.window.createQuickPick().

Fixed

  • Adding a new scope the old scope will not get overwritten.

[0.0.2] - 2023-03-29

Added

  • VSCode Marketplace Icon
  • Able to save Scopes

[0.0.1] - 2023-03-29

Added

  • First release.
  • Able to use extension to commit message.