Automate GitLab Release Notes Publishing to Outline
detail.loadingPreview
This workflow automates the creation of release notes in Outline whenever a new software release is tagged in GitLab. Ensure your team always has up-to-date documentation without manual effort.
About This Workflow
Tired of manually copying release information from GitLab into your team's knowledge base? This n8n workflow provides a seamless solution. It automatically detects new GitLab releases triggered by a tag push event, then intelligently extracts key details like the release name, description, and URL. This information is then used to instantly create a new, well-formatted document within your Outline workspace. By automating this process, you ensure that your release notes are consistently documented, easily accessible, and always in sync with your development cycle, freeing up valuable time for your engineering and product teams.
Key Features
- GitLab Tag Push Trigger: Automatically initiates the workflow upon new tag pushes in your specified GitLab repository.
- Intelligent Release Detection: Conditionally processes only actual "release" events, preventing unnecessary documentation.
- Dynamic Outline Document Creation: Creates new documents in Outline, automatically populating the title and body with GitLab release data.
- Rich Content Integration: Generates Outline content that includes the release description and a clickable link back to the GitLab release page.
- Configurable Placeholders: Easily adapt to your Outline collection and parent document structure with configurable IDs.
How To Use
- Configure GitLab Trigger Node:
- Connect your GitLab account using an access token with
apiscope. - Enter the
Owner(your GitLab username or group) andRepositoryname where releases are tagged (e.g.,tennoxandci-test). - Ensure
Eventsincludestag_push.
- Connect your GitLab account using an access token with
- Review IF Node:
- The
IFnode is pre-configured to check ifobject_kindin the GitLab payload isrelease. This ensures only actual release events are processed. No changes are typically needed here unless you wish to filter on different criteria.
- The
- Configure HTTP Request (Outline) Node:
- The
URLshould behttps://app.getoutline.com/api/documents.create. - Set
Request MethodtoPOST. - Choose
Authentication:Header Auth. Add a header withName: AuthorizationandValue: Bearer YOUR_OUTLINE_API_KEY, replacingYOUR_OUTLINE_API_KEYwith your actual Outline API token. - Ensure
JSON Parametersis checked. - In
Body Parameters (JSON), replace"collectionId": "PLACEHOLDER"and"parentDocumentId": "PLACEHOLDER"with the actual IDs from your Outline workspace where you want the documents created. You can find these IDs in Outline's URL when viewing a collection or document. - The
titleandtextexpressions are pre-configured to pull data from GitLab:{{JSON.stringify("Release " + $json.body.name)}}for the title and{{JSON.stringify($json.body.description + '\n\n\\\n[More info](' + $json.body.url + ')')}}for the body.
- The
Apps Used
Workflow JSON
{
"id": "7769b6c0-7bad-4787-b332-52c0411aa65b",
"name": "Automate GitLab Release Notes Publishing to Outline",
"nodes": 22,
"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: 7769b6c0-7bad...
About the Author
SaaS_Connector
Integration Guru
Connecting CRM, Notion, and Slack to automate your life.
Statistics
Related Workflows
Discover more workflows you might like
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.
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.
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.