changelogfa.st Client Release Note Workflow Setup (Onboarding)

changelogfa.st Client Release Note Workflow Setup (Onboarding)

1. 01

   Create a new workspace in changelogfa.st for the client account

   Log in to changelogfa.st and use the workspace creation screen to set up a dedicated environment per client. This isolates release note configurations and distribution channels, keeping each client's data and settings separate.

2. 02

   Connect the client's repository and issue tracker

   In the workspace settings, navigate to the Integrations section and connect the client's GitHub, GitLab, or Gitea repository, plus Linear or Jira for ticket enrichment. Ensure the correct repos are selected to avoid pulling commits from unrelated projects.

3. 03

   Configure the sentence-based builder for the first workflow

   Use the sentence-based builder to define a new workflow. Set the trigger to 'GitHub releases' (or merges) and specify the source branches. This builder allows you to construct the release note logic in plain language, making it easy to adjust for client preferences.

4. 04

   Select the three voices for the release notes

   In the workflow configuration, enable the technical, executive, and plain-English voices. This ensures the client receives audience-specific updates without manual rewriting. You can test each voice output in the preview pane before saving.

5. 05

   Set the distribution channels for the release notes

   Choose the destinations for the generated notes: Slack, email, webhook, or the public changelog page. For the pilot, configure at least one channel, such as Slack, and verify the webhook URL or email list is correctly entered to avoid delivery failures.

6. 06

   Enable noise filtering and ticket enrichment

   Turn on the automatic filtering of noise commits (like documentation and chores) in the workflow settings. Also, enable ticket enrichment from Linear or Jira to pull in context from linked issues, which improves the accuracy of the release notes.

7. 07

   Test the workflow with a sample release

   Trigger a test release in the connected repository to generate a sample release note. Review the output in each voice and channel to confirm the formatting and content meet the client's expectations. Adjust the builder logic if any notes are missing or incorrect.

8. 08

   Document the workflow and hand off to the client

   Create a short runbook for the client that explains how the workflow is triggered, how to modify voices or channels, and how to troubleshoot common issues. Include the recorded setup session if available, and schedule a handoff call to walk them through the configuration.