On-premise version: 4.8.0
We recently released a public Hub of best practices. This is a place where you can either contribute by importing your best practices (created from Promyze), or export them to use them in Promyze.
From the catalog page in Promyze, you now have a direct link to the Hub.
On-premise version: 4.7.0
🚀Create a new onboarding experience with the Discovery Workshops!
When you welcome new recruits in your team, they need to get familiar with your codebase and your best coding practices. If you use Promyze to record them, you're ready to create your first Discovery Workshop:
📺 Want to see the result?
This 1-minute video will guide you through a quick tour of the Discovery Workshops
⭐ Other improvements
On-premise version: 4.6.2
Our latest web browser plugin (version 3.0.7) offers a more integrated experience during code reviews on Pull / Merge Request page:
These features are currently working on GitLab, GitHub, and Azure DevOps, Bitbucket is coming soon.
We changed the behavior of our IDE plugins, and you can now enjoy suggestions from Promyze in all the source code displayed in your current editor. Previously, suggestions were provided based on your cursor position in the editor.
You'll need to update the following versions to enjoy this new behavior:
You can now sort regular expressions by order of predominance. For some best practices, you may have both positive and negative regular expressions to detect them, but you would like the detection to happen within a specific order. This is now possible using the button "Order regex" available from the suggestions settings module, which will offer you something similar to this:
So far you could only set file extensions when tuning the recommendations for practices. You can now set a file name as a pattern to be more restrictive on where the suggestions should be displayed.
On-premise version: 4.6.0
To provide more relevant recommendations, you can now configure regular expressions for positive and negative examples. You can also restrict the detection of practices to specific file extensions.
We also provide facilities to try your regular expression against custom snippets of source code or your current existing examples.
So far, you could select keywords extracted from the examples and counter-examples you've identified. Now, it's possible to add a custom set of keywords to improve our detection algorithm. Note that only alphabetical characters are allowed. If you need to go further, we recommend using regular expressions.
Similar to the regular expression feature, you can also limit the detection to some extensions of files.
So far, when you ran a Craft Workshop, all the practices identified by your team were included in the Workshop. We wanted to let our users free to start a Workshop with the content they want, in case they want to focus on specific topics or skip contributions from developers currently unavailable. Also, we wanted to provide a clearer overview of the content of the practices waiting for a review.
That's why you can now have a clear overview of what's in the Workshop, select the positive and negative examples you want to review, and click on the button "Launch the workshop" with your selection:
During a Craft Workshop, you review best practices with your team and take decisions on whether to keep or not the suggested examples. We improved the user workflow in the Workshop, and now for each practice, the workflow is more intuitive:
This new version of Promyze introduces breaking changes for all our plugins; please update your Promyze plugins to at least the following versions:
The new versions of our web browsers plugins provide closer integration on your favorite Git Platform when you're reviewing code through Pull/Merge requests.
Now, when you write down a comment that refers to a best practice explanation, a button "Create a Promyze practice" is available to submit a best practice example to Promyze! With that feature, no excuses for forgetting to make everyone in your team benefits from your explanation :)
Please note that the Chrome extension requires a new authorization to access the history of the web browser for this feature. You'll likely be asked to validate this during the plugin update.
This is currently available for GitHub and GitLab, and we're actively working on BitBucket and Azure DevOps compatibility.
On-Premise version: 4.5.8
On-Premise version: 4.5.7
♻️ Spaces can now be deleted
The spaces administration menu offers the capability to remove an entire space from your organization in Promyze.
📝 In IDEs, descriptions can be added while creating a best practice
When you identify a practice example in your IDE, you can now add a textual description to it. Previously, this was only available within the Promyze Web UI.
You need to upgrade Promyze plugins to the following versions to benefit from these features:
🌘 Eclipse plugin is here
We're happy to announce the first release of the Eclipse plugin for Promyze! You'll find all the uses cases offered by all the others plugins.
🔀 Update in Craft Workshops
The two steps "Examples from plugins" and "Examples from files" have been merged into a single step to ease navigation and user experience during a Craft Workshop.
🎨 UX improvements
We started a series of UX optimizations and improvements inside the Promyze Web UI. The next releases will continue to include more improvements.
On-Premise version: 4.5.6
We identified and resolved an issue with the authentication mechanism for Mongo 4 databases.
On-Premise version: 4.5.5
This version encloses several fixes regarding:
On-Premise version: 4.5.4
This is now possible to update through the Administration panel the URL of your Promyze instance (for On-Premise versions only).
Go to Administration -> Configuration -> Override the THEMIS_URL environment variable.
You should set the URL from which Promyze is available.
This value is enclosed in users' API keys for our plugins. In some cases, this environment variable is misconfigured and prevents the correct usage of plugins.
On-Premise version : 4.5.3
Tune recommendations with keywords configuration
It's now possible to configure for each example of best practices which keywords our algorithm should consider. You can follow this article to discover how you can configure each example.
Improve compatibility with Github, Bitbucket, and Gitlab
Promyze's web browser plugins for code reviews have been updated to increase compatibility with these systems, both Cloud and On-premise. We added information message when some specific pages are not supported yet.
Support of MongoDB 3.x and 4.x
The On-Premise version is now compatible with MongoDB higher than 2.6 version.
On-Premise version: 4.5.0
We're very proud to introduce a new feature for our IDE plugins: the automatic suggestions of best practices. Promyze leverages all the existing examples and counter-examples of your best practices to provide these recommendations.
Now, while you're coding, Promyze looks at your context (your cursor location in the editor) and suggests :
Here is a sample video demonstrating the feature in action for 4 different languages (it works for every language).
Along with the automatic suggestions features, we also redesigned the configuration process of the Promyze plugins. Now, a single API KEY is enough to connect to your Promyze instance, Cloud or on-premise. This key embeds all the information needed and removes all the complexity of connecting to Promyze.
⚠️ You need to update your IDE plugins and your configuration to make it work again.
Here is an overview of the configuration for the Visual Studio Code plugin :
Promyze now sends email notifications for Craft Workshops :
So far, when you export a catalog, only the description is included. You can now choose to ship the source code examples and have them in the final JSON output. This is definitively an improvement to share practices between organizations or Promyze instances.
On-Premise version : 4.4.0
1. New step "Practices Review" during the Retrospective
The Craft Workshop Retrospective brings a new step after usual discussions on contributions from users, related to examples and counter-examples of best practices.
The step "Practices Review" invites the team to take few minutes for the following use cases :
This step aims to help teams regularly keep their practices repository in a consistent state and be easily notified of others spaces' practices.
2. Set a goal of contributions for Craft Workshop
This feature supports teams to make sure all Craft Workshop Retrospective get enough content for discussions. It's now possible to configure a Craft Workshop with a goal of contributions to reach. In practice, the number of contributions can go beyond this goal since Promyze should never prevent anyone from contributing. Few days before the retrospective, if the goal is not reached, Promyze sends a notification reminder to the team and send congrats once the goal has been reached.
No pressure with this goal: practicing with Promyze will give your team a good overview of which goal is fine to set, depending on the size of the team. You will adjust this value for each future Craft Workshop.
3. Comments on practices
Any user can now add comments on best practices, whether they belong to one of her spaces or not. The purpose is to ease interaction with others users and keep a record of discussions about some practices. Comments are available on the best practice description.
4. Getting Started Module
We pay a lot of attention to the Onboarding process on Promyze. That's why we introduce a new widget available at any time for all the users. In addition to the "Lessons" module introduced in the previous version, this widget provides they first key steps to start with Promyze.
Other updates on this version :
On-Premise version : 4.3.5
Promyze now comes with a bundle of lessons in video, each one lasts around 30 seconds and cover topics like :
We hope it will be a great support for any new user to get started with Promyze.
This module is available from the Home Page :
2. New feature during Craft Workshop retrospective
When you go through best practices identified from plugins, you may identify with your teams some examples of counter-examples of practices that were basically not in the Craft Workshop.
You can now add the current file/snippet in the Craft Workshop content in order to identify best practices.