Step-by-step guide to create Release pages
Overview
Release pages are unique webpages designed specifically for release notes. They allow you to present your release information in an independent format. Access to these pages can be set as public, private, or restricted, providing you with the flexibility to choose who can view the release notes..
To help you get started, we are providing step-by-step guide that explain how to use these tools effectively, as they operate in slightly different ways. Once you grasp the fundamentals, you'll be able to make your own customizations based on the information provided below.
Navigation
Release pages feature is available only on the In-project screen. Navigate to the relevant Jira project >> Click on Automated Release Notes & Reports app under the project’s left navigation >> Click on Release Pages & Widgets tab >> Click on Create.
Create release page
Once you Click on Create & you’ll be brought to the Create release page screen. On this screen, in the left side, you will notice different editing options, whereas on the right side, you can see an immediate preview of the changes you have applied. The preview will be displayed based on the template you have selected from Release page template at the top dropdown.
Step 1 Select template
There are 3 types of templates available in the Release pages. Read more about the templates here - Release page & Widget templates & widget modes | Release page templates. Select the template of your choice (refer above image) and complete the configuration from the given sections one by one. All the configuration settings are explained below -
Step 2 Configurations
There are three tabs on here to configure your release page.
General
Advanced
Custom CSS
General
In the general tab there are few sections -
Details
Access level
Page design
Content
Details
Name - This is the title of the release page that appears to the end user.
Description - This is the subtitle that appears on the release page. (you can keep this one empty if you’d like)
Path - This is the path of your release page. The complete URL will be visible immediately below the textbox.
Load static resource from <yourJirasiteURL>.release.page - Read Choose how the static resources are served for your release page
Access level
In ARNR app, we offer various access types for release pages to cater to different user needs and privacy preferences. These access types allow you to control who can view the release pages created based on different use cases/for different target audiences, etc.
Below are the four access types available -
Private - This access type restricts access to the release page to only those users who have been explicitly logged in to your JSM portal. It ensures maximum privacy and confidentiality for the releases with sensitive information.
Restricted - With the restricted access type, you can manage the release page in two ways -
Restrict it for JSM users with an email from a specific domain
Restrict it for any emails with specific domains (this is independent of JSM users)
When you are using this option, users can enter their email address and if their email domain is allowed to log in to the release page, they get a link on the given email to access the release page.
Please note that the link users get via email remains active only for 24 hours. If they want to access the release page again, they should request a new link to get access.
This option balances privacy and accessibility, allowing controlled sharing of release information within relevant end users.
Public - The public access type makes the release page accessible to anyone, including users who are not logged in to the application. It is ideal for sharing release information with a wider audience, such as customers, partners, or the general public, without requiring authentication.
Off - When the access type is set to "Off," the release page is not accessible to anyone, effectively disabling its visibility. This option may be useful during development or when the release information is not ready for sharing.
How users can login to the private release page?
Jira service management (JSM) should be installed on the same Jira instance to enable private access to release page.
On the landing page, users will see the login option.
When user clicks on the login button, they will be redirected to your JSM portal login page.
Once user logs into the JSM portal with valid credentials, they will be redirected to the release page.
If the user is already logged into the JSM customer portal on the same browser, they will not be redirected to JSM login page and will get logged into the release page automatically.
How users can login to the restricted release page?
On the landing page, users will see the login option.
Below are some cases based on which you’d see how users are restricted or given access to the release page
Has JSM account (Assumption is user is not logged in to JSM account) | Belongs to given domain | Access |
|---|---|---|
Yes | Yes | User is redirected to JSM account to login. Once logged they are given an access to release page once clicked on the release page link. |
Yes | No | User is redirected to login. Once logged in and clicked on release page and below message will be displayed - This release page is not accessible to you. Please contact the release page admin to get relevant access. |
No | Yes | User is redirected to sign up on JSM. Once signed up, they need to click on release page link and they can access the release page |
No | No | User is redirected to sign up on JSM. Once signed up, they need to click on release page link however below message will be displayed - This release page is not accessible to you. Please contact the release page admin to get relevant access. |
Page design
Logo - Upload logo file (use an image with transparent background)
Favicon - Upload favicon of 48x48 size (note that only .ico files are allowed, you can use any online converters for this)
Header background color - Choose color
Header Text color - Choose color
ARNR branding - If you are using Paid app, you will be able to turn it off if needed. For the Free app, it is turned on by default and cannot be changed.
Enable anonymous reactions - This allows the users to post their reactions anonymously with Like or Dislike options.
Enable anonymous reactions toggle remains disabled by default if the release page is private
Content
Title - You can use one or more variables in the release page title that are dynamically updated with the actual value from Jira. The full list of variables is here - Customizing release notes content | (Output) Variables . This field can be kept empty.
Subtitle - In this field as well you can use one or more variables. If you do not wish to add a subtitle, keep it empty.
Issue details -
Field 1 - Here we have selected Status category
Field 2 - In image, we have selected a custom Jira issue field to publish AI-generated release notes.
Field 3 - We have picked up Issue type from the selector.
In field 1, 2 & 3, one can also use the Jira issue properties where the AI-generated release notes content is stored. Read Save release notes without Jira fields using issue properties for more details.
JQL - This is the JQL similar to what you use within ARNR templates' JQL section. Just use the default one for now.
Advanced
These are the advanced settings of the release page.
Search
Use this toggle to Enable/Disable Search on release page.
Feedback
Enable/Disable anonymous reactions with this option.
Subscription
Allow new subscribers - Enabling this feature allows the Subscribe button to appear on the release page.
Users with active subscriptions have the option to unsubscribe directly from the release page..
Send updates to the subscribers If this flag is activated, you must select a release page notification template from the options configured under the Templates tab. This selection can be made in the subsequent dropdown labeled "Select the subscriber email template."
Select subscriber email template - Whenever a new release is posted on the given release page, this email notification will be triggered for all the subscribers. Read Release page notification.
Send via email - You can either use the default email updates@releasenotes.co or add your email via SMPT settings mentioned Setting up SMTP (to send emails via your company domain).
Google analytics
Add your Google analytics measurement id (G-XXXXXXX) here to enable this feature.
This allows you to track visitor activity on my release pages. This helps to monitor visitor behavior and make informed decisions about how to optimize your content. This will enable you to view metrics such as page views, bounce rate, and time on the page.
Roadmap portal
Check our app Roadmap & Idea Portal for Jira Service Management | Atlassian Marketplace. This app allows you to manage your roadmap portal.
Read Embed release page in Roadmap portal for more details. Once you complete the integration, this section shows the identifier to embed release notes page under the roadmap portal.
RSS feed
You can now publish your release page updates directly to an RSS feed, allowing stakeholders to subscribe and stay updated through any RSS reader of their choice.
Each release page can now have its own RSS feed that updates automatically when the release is published or modified. Users can subscribe using any standard RSS feed tool.
When you create or edit a release page, you’ll see a section titled “RSS Feed” in the page builder.
Clicking the RSS icon opens a popup with link to be copied, simply copy paste the URL into your preferred feed reader to start viewing.
Step 3 - Save
Now that all mandatory configurations are filled out, click on Save.
Step 4 - Template tab
To ensure everything is set up correctly, check the template tab just to see a mock of your release page.
Step 5 - Preview
You can also preview the release page. Click on Preview tab and click on the link “Click here”.
After clicking the “Click here” link, it opens a pop-up. On the pop-up
Step 6 - Half the battle is won! Its time to set up the Rule
Now you must set up a rule to populate information on this release page. Head over to the Rules tab & click on Create. Provide the appropriate name for the rule & choose Manual trigger.
Step 7 - Click on Add release page action & choose the relevant release page
One can also decide whether subsequent actions should be executed or not if the release notes action fails.
Step 8 - Run the rule manually by providing it with a version
System shows below pop up when you click on icon on Rule details page to run the rule. Select the version and click on OK. You can use check boxes to get the relevant type of release/s in the dropdown.
Step 9 - The final step!
Click on Ok & wait for about 30 seconds for the rule to be executed. (Assuming the selected version has issues associated with it) the release page will now display the data. It will look like the image shown below.
For troubleshooting (If needed), look at the logs tab & see if you see any failure messages
On this page |
|---|
|