Welcome to the "Releases" feature – your go-to tool for tracking and communicating product updates. This guide will walk you through the steps to create releases manually and via API, ensuring a smooth and efficient process.
Creating Releases Manually:
Step 0: Go To the Releases Page
Step 1: Click on the "Add a new Release" Button
Begin by navigating to the "Releases" section and clicking on the "Add a new Release" button located at the top right corner of the page. A modal will appear, providing a structured form to input release details.
Step 2: Fill in Release Information
In the modal, you'll be prompted to fill in the following information:
Title: A concise title for the release.
Description: Provide a detailed overview of the changes and additions.
Version: Input the version number following semantic versioning (e.g., 1.0.0).
Date: Select the release date from the calendar.
Tags: Categorize the release with relevant tags.
Step 3: Save
Once you've filled in the necessary information, click the "Save" button to create the release.
Step 4: Release Created
Congratulations! 🎉 Your release is now created and visible in the "Releases" section.
Creating Releases via API:
Step 1: Click on the "Create via API" Button
For a more automated approach, click on the "Create Releases via API" button located on the top right corner of the page. A modal will appear, presenting an API token for authentication.
Step 2: Copy the Given Token
Copy the provided API token. This token will authenticate your API requests.
Step 3: Post a New Release via API
You can refer to the technical documentation for more details about creating releases with API.
Using your preferred REST API client, provide the same release information in the request body, including the title, description, version, date, and tags.
curl -X POST <https://api.screeb.app/1.0/release> \\
-H "Content-Type: application/json" \\
-H "Authorization: Bearer my_api_token" \\
-d '{
"name": "My release name",
"description": "My release description",
"version": "1.0", "tags": ["API", "V1"],
"released_at": "2023-03-22T15:22:41+00:00" // optional, will default to now }'
Step 4: Send the Request
Send the API request. Your release should now appear on the site with a "Created via API" tag, indicating its origin.
By following these simple steps, you can seamlessly manage and communicate product updates using the "Releases" feature, whether through the user interface or programmatically via API. Keep your product team informed and engaged with a transparent and efficient release process.
Seeing Releases on top of Analytics Charts
you can now correlate your modifications and the impact they have had with the analysis of the number of displays, answers, response rate and completion rate.