werk

Name: werk
Availability: InStock
Author: Checkmk

Generate Checkmk changelog entries from git commits and developer context.

2.3k|552|Updated Feb 20, 2019

Search Tags:#automation #git #changelog #developer tools #documentation #checkmk

Ready to run

npx skills add https://github.com/Checkmk/checkmk --skill werk

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: werk
Source: https://github.com/Checkmk/checkmk/tree/main/.claude/skills/werk
Command: npx skills add https://github.com/Checkmk/checkmk --skill werk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of Checkmk werks (changelog entries) by analyzing git commits and developer context, streamlining the documentation process for new features and bug fixes.

Core Features & Use Cases

Automated Werk Generation: Creates user-facing documentation from code changes.
Metadata Determination: Automatically identifies class, edition, component, level, and compatibility.
Use Case: After merging a feature branch, use this Skill to generate a werk that clearly explains the new functionality to Checkmk users, including necessary metadata and a user-friendly description.

Quick Start

Use the werk skill to create a new werk based on the provided Jira issue key and commit SHA.

Frequently Asked Questions about werk

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate Checkmk changelog entries from git commits?▼

Generate Checkmk changelog entries from git commits by analyzing code changes and developer context to determine metadata like class, edition, and level, then producing user-focused Markdown documentation.

How does automated werk generation determine component and compatibility metadata?▼

Automated werk generation determines component and compatibility metadata by analyzing the provided commit SHA and developer context to identify the appropriate class, edition, level, and compatible version information.

Can I create non-interactive changelog files and amend commits using the werk tool?▼

Yes, you can create non-interactive changelog files and amend commits by integrating with the werk tool, which automates file creation and updates the git commit with the generated documentation.

Do I need jq installed to generate Checkmk werks from code changes?▼

Yes, jq is required as a dependency to generate Checkmk werks from code changes, because the scripts process JSON data structures to extract and map commit metadata for the documentation.

What is the best way to document new features for Checkmk users after merging a branch?▼

The best way to document new features for Checkmk users after merging a branch is to analyze the commit SHA and Jira issue key to generate a werk with user-friendly Markdown descriptions and required metadata.

When should I not use automated werk generation for changelog documentation?▼

You should not use automated werk generation when your code changes lack sufficient developer context or commit history, as the tool relies on analyzing commit details to determine metadata and produce accurate documentation.