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 option.
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
This field shows the options depending on your settings done in Rules Configurations. Read the below section for more details.
Trigger
Trigeers are to decide whether your rule runs manually for automatically based on specific condistiins.
Notify success or failure
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 |
---|
|