Actions

Actions

What are actions?

When a rule is triggered, what it does is determined by actions defined inside of the rule. ARNR currently supports following types of actions.

When you add actions within a rule, these actions are executed in the sequence in the order you have organized them. For example, there is a rule with actions like Email, Confluence, LinkedIn announcements, and publish-to-release notes, etc. These actions are executed based on the set order. You can reorder them by simply drag and drop and set the sequence.

Send Video (BETA)

This action is to make it easier to create and distribute videos, especially for files that are too large to be sent as email attachments. Now, when you create a video, it will be uploaded to a secure server, and a download link will be sent to stakeholder’s email.

Below are fields in Send video action -

  • Action name - Name of the action. This is for internal reference purposes and does not affect emails being sent with video via this action.

  • Video template - Select the relevant video template that you have already saved in ARNR templates.

  • Reply to - Since the link to the video is sent in an email via ARNR’s default email (updates@releasenotes.co), in this case, you can add a reply to the email so that the receiver can reply in case of any queries.

  • Send via email - By default, you can send email via updates@releasenotes.co, or you can configure SMTP to send emails via your company's email address.

  • Email from - By default, you can send an email video link via updates@releasenotes.co, or you can configure SMTP to send emails via your company's email address.

  • Send to - Recivers can be added in the form of -

    • Jira users

    • Project roles

    • Jira groups

    • Issue users

    • Email addresses

    • Integration (This will allow you to send emails to users from Salesforce)

  • ARNR branding -

  • Send email as bcc - If Send email as Bcc is checked, it will add all the user email addresses in Bcc so that they are not transparent.

video.png

Once the video has been created and uploaded, a download link will be sent to the recipient's email address. ARNR users can find the video link in the rule execution log entry in Logs tab.

 

Send email

This action is to automate email release notes. You can select an email template along with the list of users who are supposed to receive the mail. Below are the fields in the email action -

  • Action Name - Name of the action. This is for internal reference purposes and does not affect emails being sent via this action.

  • Email template - Select the relevant email template that you have already saved in ARNR templates.

  • Attachments - Read this section below with more details

  • Reply to - Since you can send an email via ARNR’s default email (updates@releasenotes.co), in this case, you can add a reply to the email where the release notes email receiver can reply in case of any queries.

  • Send via email - By default, you can send email via updates@releasenotes.co, or you can configure SMTP to send emails via your company's email address.

Users can be added in the form of

  • Jira users

  • Project roles

  • Jira groups

  • Issue users

  • Email addresses

  • Integration (This will allow you to send emails to users from Salesforce)

Reply to & Email from parameters are used in the final email sent to the recipients. If Send email as Bcc is checked, it will add all the user email addresses in Bcc so that they are not transparent.

AR3.png

For cloud version of the app, it is possible to configure the email address from which ARNR emails are generated.

Once you are done https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/1074888705, that specific email address can be chosen from the email action - using the ‘Send via email’ selector.

Attachments

Send email with PDF attachment

Release notes in PDF format can be attached to an email. Within the send email action (same as above), there is a PDF template selector. The rest of the action parameters remain the same as those of email. At the time of rule execution, a PDF is generated using the selected template & sent as an attachment to the release mail. This release mail is generated using the template set in Email template dropdown.

Here is how to save the PDF release notes directly to a cloud storage platform such as Google Drive, Box, Dropbox, etc. https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/1657995265

Send an email with a Markdown attachment

Release notes in markdown format can be attached to an email. Within the action send email (same as above), there is a markdown template selector. The rest of the action parameters remain the same as those of email. At the time of rule execution, markdown is generated using the selected template & sent as an attachment to the release mail. This release mail is generated using the template set in the Email template dropdown.

Send email with JSON attachment

Currently, release notes in JSON format can be attached to an email. Within the action send email (same as above), there is a JSON template selector. The rest of the action parameters remain the same as those of email. At the time of rule execution, JSON is generated using the selected template & sent as an attachment to the release mail. This release mail is generated using the template set in Email template dropdown.

Send email with HTML attachment

Currently, release notes in HTML format can be attached to an email. Within the action send email (same as above), there is an HTML template selector. The rest of the action parameters remain the same as those of email. At the time of rule execution, HTML is generated using the selected template & sent as an attachment to the release mail. This release mail is generated using the template set in Email template dropdown.

Send email with Word attachment

Currently, release notes in Word format can be attached to an email (This feature is in Beta). Within the action send email (same as above), there is a Word template selector. The rest of the action parameters remain the same as those of email. At the time of rule execution, a Word doc is generated using the selected template & sent as an attachment to the release mail. This release mail is generated using the template set in Email template dropdown.

Send email with PowerPoint attachment

Using an MS PowerPoint template, one can generate an email with a PowerPoint presentation containing release notes. Within email action, there is an MS PowerPoint template sector. Select a relevant template, and the rest of the details in action remain the same. At the time of rule execution, a PowerPoint presentation is generated using the selected template & sent as an attachment to the release mail. This release mail is generated using the template set in the Email template dropdown.

If you are looking to send multiple attachments of the same type, then the feature is available in the Advanced edition of the ARMR app. Reach out to us via Service desk for access to the Advanced edition.

multi.png

 

 

Template update!

We recommend using the new Confluence editor (Cloud Confluence editor) for creating templates. Atlassian's updates offer enhanced formatting, feature support, and future compatibility. While the old editor is still available, it may not fully support the latest functionality and styling options. Read to know more in detail.

Publish to Confluence (Legacy editor)

Template update!

We recommend using the new Confluence editor (Cloud Confluence editor) for creating templates. Atlassian's updates offer enhanced formatting, feature support, and future compatibility. While the legacy editor is still available within Confluence, it may not fully support the latest functionality and styling options. Read to know more in detail.

Publish to Confluence action takes the Confluence template as an input parameter along with the space key & parent page ID. While the space key is mandatory, the parent page ID is not. If the parent page ID is not provided, the release note page will be created without a parent in Confluence.

Do keep in mind that if the space key is not valid or if the parent page ID is not valid, relevant errors will be shown in the logs & the action will fail.

There are a few possibilities based on the action configured -

  • Create a new Confluence page/blog

    • ARNR will try to create a new Confluence page/blog & the action will fail if the page with the same title already exists.

  • Update an existing Confluence page/blog

    • ARNR will check if a page/blog with the given title (based on the Confluence template in that action) already exists

      • doesn’t exist - a new Confluence page/blog will be created

      • does exist - an existing Confluence page/blog will be updated

  • Append to existing page/blog

    • ARNR will append the release notes content to an existing page/blog. ‘Dynamic section end’ text will be used to identify the string before which content will be added. If it is left empty, then content is added to the bottom of the page

  • Prepend to the existing page/blog

    • ARNR will prepend the release notes content to an existing page/blog. ‘Dynamic section start’ will be used to identify the string after which content will be added. If it is left empty, then content is added to the start of the page

  • Parent page id

    • ARNR will create a new child page under the page as per the parent page id

  • Labels

    • Multiple labels can be associated with a Confluence action. These labels will be used while creating/updating the page/blog in Confluence. Do note that space is not allowed within these labels.

  • Skip subsequent actions if this action fails

    • This option prevents subsequent actions from running if the current (parent) action fails.

Read this article to know how Confluence credentials are set up - https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/305102861

Use the page created/updated in the previous action as a parent page

  • It's possible to create both parent and child Confluence pages using the same ARNR rule. What you have to do is, under a single ARNR rule, add two Confluence actions. The first action will create a new Confluence page. The second Confluence action will create a child page under the page created through the first Confluence action.

  • It is also possible to create a Confluence page through a Confluence rule action and then append/prepend this page through a subsequent Confluence action within the same ARNR rule.

For both the above use cases, simply choose the previous Confluence action under the parent page setting, and you're done.

 

Publish to Confluence (with new editor) (Recommended approach)

This is another approach we have implemented to support the new Confluence editor. Read https://amoeboids.atlassian.net/wiki/x/A4DW6 for all the steps along with the Rule action details.

AR4.png

 

Release page & widget actions are now available within ARNR rules. Simply provide a name for the action & choose a corresponding release page/widget. That's it. Now every time this action is executed, a new entry (we call that a 'release') is created for that release page/widget. The content of this 'release' is dependent on the JQL you've configured for the release page/widget. More about that here.

AR5.png

 

 

POST to external endpoint pre-defined URL (HTML, JSON, Markdown, Slack)

In order to directly publish the release notes on a different platform or to further process them, ARNR supports the possibility of POSTing the JSON, HTML, Markdown, PDF, or MS PowerPoint to a pre-defined URL. Depending on whether the endpoint requires authentication or not, you can enter username & password.

You can preview the POST request payload using any online service such as https://webhook.site/

AR6.png

 

Jira operation

This action automates the process of adding Confluence page link/s to the "Related Work" section of a Jira release. It is designed to work in conjunction with previous Publish to Confluence (New editor) actions that generate content, making it easier to track & manage release notes and reports across different teams and platforms.

Prerequisites

  • The Jira operation action can only be added to a rule if Publish to Confluence (New editor) action has been added previously.

  • Additionally, this action requires the source template to contain a version variable or a hardcoded version for it to function correctly.

When you add the Jira operation action to a rule, you will configure the following fields:

  • Action name: This is automatically set to Action n - Jira operation.

  • Select Task: This dropdown field is currently pre-selected with the only available option:

    • Link to the related work for the version

  • Choose previous Confluence (new editor) action: This single-select dropdown will display all preceding Publish to Confluence actions. You can select one of these actions to add Confluence page links in the Jira release.

JI.png

When the rule is triggered, the Jira operation action will:

  • Automatically add links to the relevant Confluence page in the Related Work section of Jira version.

  • If a selected previous action links to multiple versions, the generated content will be linked to all of those versions.

If you want to link multiple Confluence pages to a release version add multiple Jira operation actions to the rule.

JI1.png

 

Slack

Once you are donehttps://amoeboids.atlassian.net/wiki/spaces/ARN/pages/4167729215, you can use the dedicated Send to Slack that is available under the rules. Fill out all the necessary information like the Slack template, Slack connection name, Slack channel. Once the rule action is executed, the release notes will be posted to the selected channel.

If you want to share release notes on multiple channels, add a separate rule for each channel.

AR7.png

Using the POST action

This is an older approach before we added a dedicated Slack action. If you are still using this approach, we suggest using the dedicated Slack action.

Once you have created a https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/3903488001 template, you can automate the release notes in Slack conversations/channels via a post action in ARNR. As shown in the image below, add the Action name as needed. Select Slack as the Template type. Select the relevant ARNR Slack template. Now add the Endpoint.

Read this Slack document to understand the steps for creating the Endpoint.

Once the endpoint is added, click on Save. The authorization step is not mandatory. After saving this, the release notes should get published based on the trigger set in the Rule.

AR8.png

If you face any errors, please read https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/3903520771

 

Jira service desk announcement creation

An announcement can be added to a specific project in the Jira Service Desk. This announcement can be published from within the ARNR action - JSD announcement. Expected parameters for this action include the portal ID along with the announcement template.

 

 

Generate release notes with AI

This action allows you to use AI to generate release notes. As shown in the image below, you can select the Action and Tone of the content, and more details of all the relevant fields as below -

  • Default or Custom prompt - When using the default prompt, you need to provide details in the given fields to execute AI-generated content in the given issues. Whereas, Custom prompt allows you to provide a detailed prompt to the AI generator so it can provide you with results based on the given prompt. In the custom prompt, all fields below are applicable except Action, Tone, Maximum words, and Output language as these details can be added to the custom prompt itself.

  • Action - You can decide whether you want to Summarize or Rephrase the content

  • Tone - It can be Professional, Casual, Humorous

  • Maximum words - It can be 500 words max for a multiline output field and 15 words for a single line text field selected as an output field.

  • Input Jira issue field - Select the input field. This is the field where AI refers to inputs

  • Output Jira issue field - Select the Output field. This field is updated when AI-generated content is saved.

  • JQL - Define the JQL to fetch relevant issues

  • Send mail for this update - By selecting this option, an update notification will be sent for each issue affected by this bulk operation.

  • Skip subsequent actions if this action fails - If set to True, the subsequent actions will fail if this action fails for some reason

Click on Save.

AR8.png

When this action is executed, the AI-generated content is updated in the selected Jira issue output field. Then that content is fetched in subsequent actions to publish in release notes.

 

Publish to social media

This action allows posting release notes announcements on social media platforms. At the moment, only the LinkedIn platform is enabled. read https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/3925278721 template.

AR10.png
  • Action name - Edit the action name for internal action identification

  • Template type - Currently, only the LinkedIn announcement template is available for social media platforms, so that is selected by default. We plan to add more such social media platform templates shortly.

  • Select template - Select one of the LinkedIn announcement templates from the dropdown

  • LinkedIn connection - Here, the LinkedIn connection name is selected by default as per the selection of connections in the LinkedIn integration setup. The same will be applicable for all social media rule actions across all projects on that instance.

  • Posting as - This option will show the default selection based on the LinkedIn integration settings.

  • Attachments - You can post PDF, MS Word, or PowerPoint presentation files in the LinkedIn announcements using this option.

    • Select the attachment type and select a relevant template for the same.

As shown in the above image, assume there is a Rule set to publish ARNR release notes. In this rule, there are two actions. 1 - Release page, 2- social media. Upon the rule execution, the first action will be executed, which publishes the release notes to a release page. The second action will be executed to make a LinkedIn announcement of the same release version. This action will pick the Release page URL and replace it with the [releasepageURL] variable added in the main content of LinkedIn announcement template.

Same logic is applied when [ConfluenceURL] variable is used in the main content of the template is executed with the Publish to Confluence action (old/new). The Confluence page URL will be replaced in the LinkedIn announcement.

If there are no actions for Confluence/release page and there are URL variables used in template, then no value will be replaced. Thus, make sure you are adding the relevant action in the rule.

Read the current Limitations with the LinkedIn announcement.

If you do not see this Rule action, please check https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/202702910.

 

Send to MS Teams

  • Action name - Edit the action name if needed for internal records and identification

  • Select template - Select the MS Teams template created in ARNR templates

  • Select MS teams connection - Select the MS Teams connection that is created in ARNR Integration settings

  • Select team - Select the relevant Team from your MS Teams

  • Select channel - Select the MS Teams' channel

AR11.png

Once above setup is done, Save the action. When this action is executed, the release notes will be published to the selected channel. If you wish to post release notes to different channels, you can create more actions in the same way, with different channels in each action.

 

Zendesk

  • Action name - Edit the action name if needed for internal records and identification

  • Select template - Select the Zendesk template created in ARNR templates

  • Select Zendesk connection - Select the Zendesk connection that is created in ARNR Integration settings

  • Type - Currently, only the Article option is available

  • Select category - Currently, only the General category is available

  • Select section - Select whether you want to publish release notes to the FAQ or Announcements

  • Select permission group - Select the relevant group that has permission to view release notes

 

zenD.png

Once above setup is done, Save the action. When this action is executed, the release notes will be published to Zendesk. If you wish to post release notes to different groups or sections, you can create more actions in the same way, with different channels in each action.

Sort/Reorder actions

When a rule is created, multiple rule actions can be added to the rule. These rule actions are executed one after another. In some cases, the rules depend on previous rules being executed successfully. This requires the user to create the rule actions in a sequence. That is why, no matter in what order rule actions are created, one can reorder them as needed and save the rule.