diff --git a/change-notes/0_20_1.html b/change-notes/0_20_1.html new file mode 100644 index 00000000..cf98fe5b --- /dev/null +++ b/change-notes/0_20_1.html @@ -0,0 +1,12 @@ +

0.20.1 (22/04/2022)

+

+ Thirty-third alpha release.
+ Fixes and refactorings +

+ diff --git a/gradle.properties b/gradle.properties index a1f70e44..c6a275ea 100644 --- a/gradle.properties +++ b/gradle.properties @@ -5,7 +5,7 @@ pluginUntilBuild=221.* # Needs a change-notes page with matching version in ./change-notes/ # Also need to map the version to change-notes document # in com.github.lppedd.cc.whatsnew.DefaultWhatsNewProvider.whatsNewPages -version=0.20.0 +version=0.20.1 # (Optional) Absolute path to a DCEVM-enabled VM, eg. '.../bin/java.exe' dcevmExecutable= diff --git a/src/main/kotlin/com/github/lppedd/cc/whatsnew/DefaultWhatsNewProvider.kt b/src/main/kotlin/com/github/lppedd/cc/whatsnew/DefaultWhatsNewProvider.kt index 953a002d..e10ac942 100644 --- a/src/main/kotlin/com/github/lppedd/cc/whatsnew/DefaultWhatsNewProvider.kt +++ b/src/main/kotlin/com/github/lppedd/cc/whatsnew/DefaultWhatsNewProvider.kt @@ -20,11 +20,11 @@ internal class DefaultWhatsNewProvider : WhatsNewProvider() { } private val whatsNewPages = listOf( + WhatsNewPage("0.20.1", "0_20_1.html"), WhatsNewPage("0.20.0", "0_20_0.html"), WhatsNewPage("0.19.0", "0_19_0.html"), WhatsNewPage("0.18.0", "0_18_0.html"), WhatsNewPage("0.17.0", "0_17_0.html"), - WhatsNewPage("0.16.1", "0_16_1.html"), ) override fun getDisplayName(): String = diff --git a/src/main/resources/whatsnew/0_16_1.html b/src/main/resources/whatsnew/0_16_1.html deleted file mode 100644 index 486441fc..00000000 --- a/src/main/resources/whatsnew/0_16_1.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - -
-

Table of contents:

-

• Towards 1.0 and a plea to users

-

• Changes in 0.16.1

-

• Future plans

-
-

Towards 1.0 and a plea to users

-

First and foremost, I hope you don't mind the long text!

-

- As some of you may have noticed, the updates cadence has decreased lately. - Not because I don't have time (well, maybe) but because the features and bug-fixes - I'm facing are pretty hard to implement or to investigate and fix while also - maintaining compatibility with IDEA 2019.2+. -

-

- This is where all of you come in to play! - Please report any sort of issue you encounter in completion, settings, UI, - and let me know about any idea of feature which could benefit everyone. - I'm especially interested in your answers to a couple questions: -

-

- • what's your IDE release (e.g. 2020.1)?
- • are you using template completion?
- • what's the most useless feature you encountered? -

-

- I've opened a feedback issue - on GitHub where you can write whatever you want.
- And if you don't own a GitHub account, please contact me at lp.edoardo(at)gmail.com -

-

- With this in mind, I hope by the beginning of the new year we'll have the first - stable version. -

-

Changes in 0.16.1

-

- This release packs more then 100 commits which include new features, extensive refactorings, - and bug fixes. Following is a short but comprehensive summary. -

- -

Features:

-

- • differentiated the token's displayed value (in completion popup) from its real value.
- This enhancement seems like a small detail, but it's huge as it let's us search an item by a comprehensible - text while outputting another value. Think about a GitHub issue: you search via its title but - want its number to be inserted. -

-

- • allowed using a custom Co-authors file.
- The co-authors file is created/picked-up from the project's base directory; however with this enhancement - you're also able to select a file using an absolute path. -

-

- • allowed sorting body, footer type, and footer value tokens.
- This is accessible via the Settings > Conventional Commit > Providers tab. -

-

- • displayed changelogs/news inside a dedicated dialog (this very dialog!) and exposed a public API. - Even extensions are able to add their own tabs. -

-

- • preselected the top item in completion's popup when using context completion.
- This change removes the need to use the down-arrow key to begin selecting items, - so that you can immediately complete.
- Should this be optional? Let me know in the feedback issue. -

-

- • cleaned-up whatever the plugin created if it is uninstalled.
- Currently only some non-roamable properties are removed, but this will be expanded in the future if necessary. -

- -

Fixes:

-

- • used the correct project's base path.
- Probably from 2020.3, the platform API started returning the .idea folder as the project's base path. - This is obviously wrong and hinders the auto-discovery of the default tokens file (conventionalcommit.json) - and of the Co-authors file (conventionalcommit.coauthors). -

-

- • allowed commit message reformatting using keys shortcut in 2020.2+
- This is a platform problem (IDEA-254830) but I managed - to workaround it. -

- -

Refactorings:

-

- • improved the completion process.
- In conjunction with the first mentioned feature, I've replaced the underlying code that performs the completion item - insertion. That is now smarter and lighter, but there might be issues, so report them in case. -

-

- • improved the UI.
- The user interface now strictly follows the platform guidelines (and even goes beyond) - aiming at offering the best possible user experience.
- Scaling of panels and controls is taken into account everywhere to ease working with big monitors - and higher resolutions. -

-

Future plans

-

- Until the end of the year I would like to focus on the features we already have, and on bug fixes if required. - This doesn't mean I don't want to add new things, but that to be considered they - must provide good value.
- What I already planned: -

-

- • work on new extensions! I've already written a POC for GitHub issues integration. -

-

• handle more edge cases in completion.

-

- • stabilize and document the exposed API.
- This will allow more third-party extensions to become available. -

-

- • clean-up the code and add in-code documentation to attract contributors.
- I'm already doing this, but it's a never ending task. -

-

- • investigate improvements for the What's New dialog.
- Currently I'm using a Swing embedded browser, however I would like to move to a native Swing component. -

-
-

Contributors

-

- I'd like to thank ymind for the - Chinese localization, all the people who tried out the plugin, - and the ones who submitted issues during the months. -

-
- diff --git a/src/main/resources/whatsnew/0_20_1.html b/src/main/resources/whatsnew/0_20_1.html new file mode 100644 index 00000000..e4ab9ac5 --- /dev/null +++ b/src/main/resources/whatsnew/0_20_1.html @@ -0,0 +1,106 @@ + + + + + +
+

Table of contents:

+

• Apologies

+

• Compatibility with IDEA 2022.*

+

• Fixes in 0.20.1

+

• Quick Documentation issues (Platform)

+
+

Apologies

+

+ Many of you probably asked themselves why I haven't been updating this plugin as frequently as I did in the past. +

+

+ Well, long story short, I haven't been working on IDEA - at least not constantly - + as I've been developing Eclipse RCP products and plugins starting from April 2021, with a development stack + that isn't what you'd look for nowadays. The products' VCS, Rational Team Concert, isn't supported + at all in IDEA (I did open a ticket for IBM in 2018), so that ruled out completely the possibility of using it. +

+

+ Other than that, I was burned-out and just thinking about committing to GitHub made me really uncomfortable. + I kept postponing forever in favor of playing Call of Duty (gotta admit that). Maybe I was feeling a bit down, + or maybe I was stressed out too much. +
+ I hope this shed some light on what was going on during these last months, and it's indeed my fault + if I haven't answered issues or pull requests. +

+

+ Some of you emailed me directly, and I really appreciated it. My email (lp.edoardo@gmail.com) is always open, + so if you notice I'm not answering on GitHub, you're welcome to forward your issues there too! +
+ I'd like to thank everyone who still visited the repository to report issues or to try to fix what I wasn't able to fix + myself. +

+

Compatibility with IDEA 2022.*

+

+ The biggest change that comes with this release is compatibility with IDEA 2022.*. As I was mentioning in + previous What's new pages, my goal is to keep supporting as many Platform's versions as possible, + so that people with older IDEs are still able to enjoy using Conventional Commits. +

+

+ Unfortunately, each new version increases the odds of unexpected behaviors, which can obviously + only be observed at runtime. For your interest, I'm using a special annotation, + @Compatibility, + to document code that is written for the specific purpose of supporting every possible version. +
+ Have a look at its usages if you want. +

+

Fixes in 0.20.1

+

This minor release fixes a couple of issues, specifically:

+ +

Quick Documentation issues (Platform)

+

+ The Quick Documentation component seems to not be stable anymore since the beginning of 2021. + We currently have an issue opened for this, + but beware this is in fact a Platform problem. +

+

+ Here are the relevant issues on IDEA's YouTrack:
+ IDEA-261691
+ IDEA-262653
+ IDEA-292730 +

+