Rules
What are rules?
Rules is where you automate the release notes generation process. In essence, rules are a collection of ‘Actions’ tied together by a ‘Trigger’. Each rule can have one trigger & multiple actions. There can be multiple rules in in-project as well as on the cross-project screen.
Columns on the Rules page
Trigger - This displays what trigger is selected in the rule
Name - Name of the Rule
Action - It shows the actions within the rules (indicated with icons)
Last used - Date when the rule was used
Enabled - Whether the rule is Enabled/Disabled
Last modified by - User who modified the rule
Last modified date - Date when the rule was last modified
You can decide what all colums should be visible for you on the rules page from the columns setting 
Create a rule
Click on ‘Create’ on Rules tab and below are the different fields you will see on Create Rule page -
Rule name
Write the name of your rule. This is only for record purposes and is not visible to end users of release notes.
Enabled/Disabled
With this flag you can enable/disable the rule
Run Rule as
Read Run rule as for more details.
Trigger
Triggers are to decide whether your rule runs manually for automatically based on specific conditions.
Notify success or failure
Background
This setting enables you to set up email notifications that are sent to the rule owner/admin with the rule execution statuses. So, for any reason if the the rule fails, relevant users and informed and they can take the relevant actions.
Conndition for sending notifications
Clicking on Notify on success/failure field below dropdown options are available.
Options | Action when option selected |
|---|---|
Notify when at least one rule action fails to execute | Only when at least one rule action fails to execute, the selected users will be notified |
Notify for every rule execution | The selected users will be notified every time the rule is executed - successfully or unsuccessfully |
Do not notify | No users will be notified |
Select users
Once you have selected the appropriate option, you can add relevant email addresses to Select users field.
If the value of Notify on success/failure field is set to - Do not notify, user selector field will be disabled.
For every new rule, the default value for Notify on success/failure field will be set to Notify when at least one rule action fails to execute.
Click on Save and the rule is now created! Now you can add actions, these actions are executed in the sequence of the order you have organized them. For eg. There is rule with actions like Email, Confluence, LinkedIn announcements, and publish-to-release notes. Based on their order rules are executed. You can reorder them by simple drag and drop.
Important points to note
Rules can only be created at the local & cross-project level.
An in-project rule can only be used, edited, or deleted in the project in which it is created AND
A cross-project rule can only be used, edited, or deleted from the cross-project screen.
In-project vs Cross-project
Behaviour of the rules is the same in both the cases
Except, the Cross-project rules have a limited number of triggers (discussed more in the triggers article)
Do note that, actions can only be added after the rule is saved.
On this page |
|---|
|