Automate GitLab Release Notes to Outline Documentation
detail.loadingPreview
This workflow automatically creates and publishes detailed release notes in Outline whenever a new release is tagged and pushed to your GitLab repository. Streamline your documentation process and ensure consistency with every product update.
About This Workflow
Manually drafting release notes or updating documentation after every new software release can be a tedious and error-prone task. This n8n workflow solves that challenge by providing a seamless automation pipeline directly from GitLab to Outline. Triggered by a new tag push that signifies a release, the workflow intelligently extracts critical information like the release name, description, and URL. It then uses this data to dynamically generate and publish a new, well-formatted document in Outline, ensuring your team or users always have access to up-to-date release information without manual intervention.
Key Features
- GitLab Release Trigger: Automatically initiates the workflow upon detection of a new release tag push in a specified GitLab repository.
- Conditional Release Detection: Uses an IF node to ensure the workflow only proceeds for actual "release" events, preventing unnecessary documentation for non-release tags.
- Dynamic Document Creation: Generates new Outline documents with titles like "Release [Tag Name]" and content populated directly from the GitLab release description and URL.
- Automated Publishing: Instantly publishes the newly created release notes in Outline, making them immediately available.
- Customizable Content: Easily adapt the Outline document's title and body content using dynamic expressions from your GitLab release data.
How To Use
- Configure GitLab Trigger:
- Select the "Gitlab Trigger" node.
- Choose your GitLab account credentials or create new ones.
- Enter the
OwnerandRepositoryname where your releases occur (e.g.,tennoxandci-test). - Ensure "tag_push" is selected under
Events. - Save the workflow and activate the webhook in your GitLab repository settings.
- Verify IF Node (No Configuration Needed):
- The "IF" node is pre-configured to check if the incoming event's
object_kindis "release". No changes are typically needed here unless your GitLab setup uses a differentobject_kindfor releases.
- The "IF" node is pre-configured to check if the incoming event's
- Set Up HTTP Request (Outline):
- Select the "HTTP Request" node.
- Configure
Authenticationto "Header Auth" and input your Outline API key (e.g., as a Bearer token or custom header). - Replace
"PLACEHOLDER"forcollectionIdandparentDocumentIdwith the actual IDs of the Outline collection and parent document where you want the new release notes to be created. You can find these IDs in Outline's URL when viewing a collection or document. - The
titleandtextfields are dynamically populated using expressions like{{JSON.stringify("Release " + $json.body.name)}}and{{JSON.stringify($json.body.description + '\n\n\\\n[More info](' + $json.body.url + ')')}}. Adjust these expressions if you want to customize the content further.
Apps Used
Workflow JSON
{
"id": "020130af-5999-4215-90e0-f607a2e598f6",
"name": "Automate GitLab Release Notes to Outline Documentation",
"nodes": 14,
"category": "DevOps",
"status": "active",
"version": "1.0.0"
}Note: This is a sample preview. The full workflow JSON contains node configurations, credentials placeholders, and execution logic.
Get This Workflow
ID: 020130af-5999...
About the Author
Free n8n Workflows Official
System Admin
The official repository for verified enterprise-grade workflows.
Statistics
Related Workflows
Discover more workflows you might like
Automated PR Merged QA Notifications
Streamline your QA process with this automated workflow that notifies your team upon successful Pull Request merges. Leverage AI and vector stores to enrich notifications and ensure seamless integration into your development pipeline.
Automate Qualys Report Generation and Retrieval
Streamline your Qualys security reporting by automating the generation and retrieval of reports. This workflow ensures timely access to crucial security data without manual intervention.
Robust Concurrency Control for n8n Workflows with Redis
Prevent simultaneous execution of critical n8n workflows or tasks using a centralized, Redis-backed locking mechanism. This reusable utility workflow ensures data integrity and resource management by allowing other workflows to acquire, check, and release locks.