diff --git a/skills/automated-release-setup/automated-release-setup.md b/.claude/skills/automated-release-setup/SKILL.md similarity index 97% rename from skills/automated-release-setup/automated-release-setup.md rename to .claude/skills/automated-release-setup/SKILL.md index 740e224..d5f5a85 100644 --- a/skills/automated-release-setup/automated-release-setup.md +++ b/.claude/skills/automated-release-setup/SKILL.md @@ -1,8 +1,13 @@ -# Skill: Setup Automated Release Workflow - -Trigger: User asks to set up automated release workflow for a SonarSource analyzer project - -## Instructions +--- +name: automated-release-setup +description: > + Use this skill whenever the user asks to "set up automated release", "configure release automation", + "add automated release workflow", or any variation of setting up the automated release workflow for + a SonarSource analyzer project. This skill gathers project details, creates workflow files, updates + existing release workflows, and sets up vault permissions. +--- + +# Setup Automated Release Workflow Help the user set up the automated release workflow by gathering required information and creating the necessary workflow files. diff --git a/README.md b/README.md index c2140a0..78c8f67 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,88 @@ A centralized collection of reusable GitHub Actions designed to streamline and a ## Claude Code Skills -This repository includes [Claude Code skills](skills/README.md) for automating common tasks related to release workflows. +This repository includes Claude Code skills for automating common tasks related to release workflows. Skills are instruction files (`.claude/skills//SKILL.md`) that teach Claude Code how to perform specific tasks, using YAML frontmatter for metadata followed by detailed instructions. + +### Available Skills | Skill | Description | |-------|-------------| -| [automated-release-setup](./skills/automated-release-setup/) | Set up automated release workflow for SonarSource analyzer projects | +| [automated-release-setup](.claude/skills/automated-release-setup/) | Set up automated release workflow for SonarSource analyzer projects | + +### Usage + +#### In this repository (automatic) + +Skills in `.claude/skills/` are automatically discovered by Claude Code when you work in this repository. Simply ask Claude Code to perform the task: + +- "Set up automated release workflow" +- "Configure automated release for this project" +- "Help me create the release automation workflows" + +Or use the slash command: `/automated-release-setup` + +#### In other repositories (manual installation) + +To use these skills in other repositories, you can either download them or symlink them. + +**Option 1: Download and Install Manually** + +```bash +# Create the skills directory if it doesn't exist +mkdir -p .claude/skills/automated-release-setup + +# Download the skill +curl -o .claude/skills/automated-release-setup/SKILL.md \ + https://raw.githubusercontent.com/SonarSource/release-github-actions/master/.claude/skills/automated-release-setup/SKILL.md +``` + +**Option 2: Clone and Symlink** + +1. Clone this repository (if you haven't already): + + ```bash + git clone https://github.com/SonarSource/release-github-actions.git + ``` + +2. Create a symlink to the skill directory in your target repository: + + ```bash + mkdir -p .claude/skills + ln -s /path/to/release-github-actions/.claude/skills/automated-release-setup \ + .claude/skills/automated-release-setup + ``` + +### Updating Skills + +```bash +# If installed via curl +curl -o .claude/skills/automated-release-setup/SKILL.md \ + https://raw.githubusercontent.com/SonarSource/release-github-actions/master/.claude/skills/automated-release-setup/SKILL.md + +# If installed via symlink, just pull the latest changes +cd /path/to/release-github-actions +git pull +``` + +### Creating New Skills + +1. Create a new directory under `.claude/skills/` with your skill name +2. Add a `SKILL.md` file with YAML frontmatter (`name`, `description`) followed by the skill instructions +3. Update this README to include your skill in the "Available Skills" table +4. Submit a pull request + +```markdown +--- +name: my-skill-name +description: > + Trigger description explaining when Claude Code should activate this skill. + Include example phrases like "set up X", "configure Y", etc. +--- + +# Skill Title + +Detailed instructions for Claude Code to follow... +``` ## Development diff --git a/skills/README.md b/skills/README.md deleted file mode 100644 index 7d3dd97..0000000 --- a/skills/README.md +++ /dev/null @@ -1,77 +0,0 @@ -# Claude Code Skills - -This directory contains Claude Code skills for automating common tasks related to release workflows. - -## What are Skills? - -Skills are instruction files that teach Claude Code how to perform specific tasks. When you install a skill, Claude Code can automatically help you with that task when you ask for it. - -## Available Skills - -| Skill | Description | -|-------|-------------| -| [automated-release-setup](./automated-release-setup/) | Set up automated release workflow for SonarSource analyzer projects | - -## Installation - -### Option 1: Download and Install Manually - -Download the skill file to your Claude Code skills directory: - -```bash -# Create the skills directory if it doesn't exist -mkdir -p ~/.claude/skills - -# Download the skill -curl -o ~/.claude/skills/automated-release-setup.md \ - https://raw.githubusercontent.com/SonarSource/release-github-actions/master/skills/automated-release-setup/automated-release-setup.md -``` - -### Option 2: Clone and Symlink - -1. Clone this repository (if you haven't already): - - ```bash - git clone https://github.com/SonarSource/release-github-actions.git - ``` - -2. Create a symlink to the skill: - - ```bash - mkdir -p ~/.claude/skills - ln -s /path/to/release-github-actions/skills/automated-release-setup/automated-release-setup.md \ - ~/.claude/skills/automated-release-setup.md - ``` - -## Usage - -Once installed, simply ask Claude Code to help you with the task. For example: - -- "Set up automated release workflow" -- "Configure automated release for this project" -- "Help me create the release automation workflows" - -Claude Code will recognize the request and follow the skill instructions to guide you through the process. - -## Updating Skills - -To update a skill to the latest version: - -```bash -# If installed via curl -curl -o ~/.claude/skills/automated-release-setup.md \ - https://raw.githubusercontent.com/SonarSource/release-github-actions/master/skills/automated-release-setup/automated-release-setup.md - -# If installed via symlink, just pull the latest changes -cd /path/to/release-github-actions -git pull -``` - -## Creating New Skills - -If you want to contribute a new skill: - -1. Create a new directory under `skills/` with your skill name -2. Add a markdown file with the skill instructions (use the existing skill as a template) -3. Update this README and the main repository README to include your skill in the "Available Skills" table -4. Submit a pull request \ No newline at end of file