fips-agents-cli 0.1.1__tar.gz → 0.1.2__tar.gz

fips_agents_cli-0.1.2/.claude/commands/create-release.md

@@ -0,0 +1,75 @@
+---
+description: Prepare and publish a new release version
+tags: [release, publish, version]
+---
+
+You are assisting with creating a new release for the fips-agents-cli project.
+
+## Your Task
+
+1. **Ask the user for release information:**
+   - New version number (format: x.y.z, e.g., 0.1.2)
+   - Release notes/description of changes
+
+2. **Update the README.md changelog:**
+   - Read the current README.md file
+   - Add a new version section under the `## Changelog` heading
+   - Format as:
+     ```markdown
+     ### Version X.Y.Z
+
+     - Feature/Fix: Description of change
+     - Feature/Fix: Description of change
+     ```
+   - Place the new version ABOVE older versions (newest first)
+   - Use the release notes provided by the user to populate the changelog
+
+3. **Run the release script:**
+   - After updating the changelog, run the release script:
+     ```bash
+     ./scripts/release.sh <version> "<commit-message>"
+     ```
+   - The commit message should be a concise summary of the release (e.g., "Add generator commands")
+
+## Important Notes
+
+- The release script will:
+  - Update version in `version.py` and `pyproject.toml`
+  - Commit all changes (including the changelog you updated)
+  - Create and push a git tag
+  - Trigger automated GitHub Actions for PyPI publishing
+
+- Version format must be x.y.z (three numbers separated by dots)
+- Follow semantic versioning:
+  - Major (1.0.0): Breaking changes
+  - Minor (0.1.0): New features, backward compatible
+  - Patch (0.1.1): Bug fixes, backward compatible
+
+- The changelog should be clear and user-focused
+- Group related changes together
+- Use consistent formatting
+
+## Example Interaction
+
+User: "I want to release version 0.1.2"
+
+You should:
+1. Ask: "What changes are included in version 0.1.2? Please describe the new features, fixes, or improvements."
+2. User provides: "Added support for middleware generation, fixed bug in tool validation, improved error messages"
+3. You update README.md changelog:
+   ```markdown
+   ### Version 0.1.2
+
+   - Feature: Added support for middleware generation
+   - Fix: Fixed bug in tool validation
+   - Improvement: Improved error messages
+   ```
+4. You run: `./scripts/release.sh 0.1.2 "Add middleware generation support"`
+5. Confirm success and provide links to monitor the release
+
+## Validation
+
+Before running the script, verify:
+- Version number is in correct format (x.y.z)
+- Changelog is properly formatted
+- User has confirmed the changes are ready to release

{fips_agents_cli-0.1.1 → fips_agents_cli-0.1.2}/CLAUDE.md

@@ -64,6 +64,49 @@ pip install -e .
 fips-agents --version
 ```
 
+### Creating a Release
+
+**Automated Method (Recommended):**
+
+Use the `/create-release` slash command in Claude Code:
+
+```
+/create-release
+```
+
+This command will:
+1. Ask for version number and release notes
+2. Update the changelog in README.md
+3. Run `scripts/release.sh` to:
+   - Update version in `version.py` and `pyproject.toml`
+   - Commit and push changes
+   - Create and push git tag
+   - Trigger GitHub Actions for automated PyPI publishing
+
+**Manual Method:**
+
+**IMPORTANT**: Version numbers must be updated in TWO places:
+1. `src/fips_agents_cli/version.py`
+2. `pyproject.toml`
+
+```bash
+# 1. Update version in both files manually or use the script:
+./scripts/release.sh <version> "<commit-message>"
+
+# Example:
+./scripts/release.sh 0.1.2 "Add new generator features"
+
+# The script handles:
+# - Updating version.py and pyproject.toml
+# - Committing changes (including README.md changelog)
+# - Creating and pushing tag
+# - Triggering GitHub Actions
+```
+
+**Note**: Always update the changelog in README.md before running the script.
+
+See `RELEASE_CHECKLIST.md` for detailed release procedures and troubleshooting.
+
 ## Architecture
 
 ### Module Structure
@@ -148,24 +191,29 @@ def test_something(temp_dir):
 ### pyproject.toml
 
 - **Build System**: Uses Hatchling (not Poetry or setuptools)
-- **Python Version**: Requires ≥3.9, supports 3.9-3.12
+- **Python Version**: Requires ≥3.10, supports 3.10-3.12 (dropped 3.9 in v0.1.1)
 - **Line Length**: Black and Ruff both configured for 100 characters
 - **Entry Point**: `fips-agents = "fips_agents_cli.cli:main"`
 - **Test Configuration**: pytest runs with coverage by default
+- **Version Management**: Version number must match `src/fips_agents_cli/version.py`
 
 ### CI/CD Workflows
 
 **test.yml**: Runs on push/PR to main
-- Matrix testing across Python 3.9, 3.10, 3.11, 3.12
+- Matrix testing across Python 3.10, 3.11, 3.12 (dropped 3.9 support in v0.1.1)
 - Runs pytest with coverage
 - Checks Black formatting
 - Runs Ruff linting
 - Builds distribution and validates with twine
 
-**workflow.yaml**: Publishes to PyPI on GitHub releases
-- Uses trusted publishing (no API key needed)
+**workflow.yaml**: Automated release and PyPI publishing (triggered by version tags)
+- Triggers on `v*.*.*` tags (e.g., `v0.1.1`)
+- Verifies tag version matches both `version.py` and `pyproject.toml`
+- Extracts changelog from README.md
+- Creates GitHub Release automatically
 - Builds wheels and source distributions
-- Uploads to PyPI automatically
+- Publishes to PyPI using trusted publishing (no API key needed)
+- **Important**: This single workflow handles the complete release process - DO NOT create separate release workflows
 
 ## Common Development Patterns
 

{fips_agents_cli-0.1.1 → fips_agents_cli-0.1.2}/LICENSE

@@ -2,6 +2,8 @@ MIT License
 
 Copyright (c) 2025 Wes Jackson
 
+Note: Some code in this project was written with AI.
+
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

{fips_agents_cli-0.1.1 → fips_agents_cli-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fips-agents-cli
-Version: 0.1.1
+Version: 0.1.2
 Summary: CLI tool for creating and managing FIPS-compliant AI agent projects
 Project-URL: Homepage, https://github.com/rdwj/fips-agents-cli
 Project-URL: Repository, https://github.com/rdwj/fips-agents-cli
@@ -47,19 +47,31 @@ A command-line tool for creating and managing FIPS-compliant AI agent projects,
 
 ## Installation
 
-### Using pipx (Recommended)
+**Recommended:** Install with [pipx](https://pipx.pypa.io/) for isolated command-line tools:
 
 ```bash
 pipx install fips-agents-cli
 ```
 
-### Using pip
+pipx installs the CLI in an isolated environment while making it globally available. This prevents dependency conflicts with other Python packages.
+
+<details>
+<summary><b>Alternative: Using pip</b></summary>
+
+If you prefer pip or don't have pipx installed:
 
 ```bash
 pip install fips-agents-cli
 ```
 
-### From Source (Development)
+**Note:** Consider using a virtual environment to avoid dependency conflicts.
+
+</details>
+
+<details>
+<summary><b>Alternative: Install from source (for development)</b></summary>
+
+For contributing or local development:
 
 ```bash
 # Clone the repository
@@ -74,6 +86,8 @@ source venv/bin/activate  # On Windows: venv\Scripts\activate
 pip install -e .[dev]
 ```
 
+</details>
+
 ## Quick Start
 
 ### Create a new MCP server project
@@ -514,7 +528,14 @@ MIT License - see LICENSE file for details
 
 ## Changelog
 
-### Version 0.1.1 (Current)
+### Version 0.1.2
+
+- Documentation: Updated documentation and improved release management guidance
+- Automation: Added `/create-release` slash command for automated release workflow
+- Automation: Created `scripts/release.sh` for streamlined version management and tagging
+- Documentation: Added `RELEASE_CHECKLIST.md` with comprehensive release procedures
+
+### Version 0.1.1
 
 - Added `fips-agents generate` command group
 - Component generation: tools, resources, prompts, middleware

{fips_agents_cli-0.1.1 → fips_agents_cli-0.1.2}/README.md

@@ -14,19 +14,31 @@ A command-line tool for creating and managing FIPS-compliant AI agent projects,
 
 ## Installation
 
-### Using pipx (Recommended)
+**Recommended:** Install with [pipx](https://pipx.pypa.io/) for isolated command-line tools:
 
 ```bash
 pipx install fips-agents-cli
 ```
 
-### Using pip
+pipx installs the CLI in an isolated environment while making it globally available. This prevents dependency conflicts with other Python packages.
+
+<details>
+<summary><b>Alternative: Using pip</b></summary>
+
+If you prefer pip or don't have pipx installed:
 
 ```bash
 pip install fips-agents-cli
 ```
 
-### From Source (Development)
+**Note:** Consider using a virtual environment to avoid dependency conflicts.
+
+</details>
+
+<details>
+<summary><b>Alternative: Install from source (for development)</b></summary>
+
+For contributing or local development:
 
 ```bash
 # Clone the repository
@@ -41,6 +53,8 @@ source venv/bin/activate  # On Windows: venv\Scripts\activate
 pip install -e .[dev]
 ```
 
+</details>
+
 ## Quick Start
 
 ### Create a new MCP server project
@@ -481,7 +495,14 @@ MIT License - see LICENSE file for details
 
 ## Changelog
 
-### Version 0.1.1 (Current)
+### Version 0.1.2
+
+- Documentation: Updated documentation and improved release management guidance
+- Automation: Added `/create-release` slash command for automated release workflow
+- Automation: Created `scripts/release.sh` for streamlined version management and tagging
+- Documentation: Added `RELEASE_CHECKLIST.md` with comprehensive release procedures
+
+### Version 0.1.1
 
 - Added `fips-agents generate` command group
 - Component generation: tools, resources, prompts, middleware

{fips_agents_cli-0.1.1 → fips_agents_cli-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fips-agents-cli"
-version = "0.1.1"
+version = "0.1.2"
 description = "CLI tool for creating and managing FIPS-compliant AI agent projects"
 readme = "README.md"
 requires-python = ">=3.10"

fips_agents_cli-0.1.2/scripts/README.md

@@ -0,0 +1,89 @@
+# Release Scripts
+
+This directory contains automation scripts for the fips-agents-cli project.
+
+## release.sh
+
+Automated release script that handles version bumping, tagging, and triggering the release pipeline.
+
+### Usage
+
+```bash
+./scripts/release.sh <version> "<commit-message>"
+```
+
+### Arguments
+
+- `version`: Version number in format x.y.z (e.g., 0.1.2)
+- `commit-message`: Short description of the release changes
+
+### Example
+
+```bash
+./scripts/release.sh 0.1.2 "Add middleware generation support"
+```
+
+### What It Does
+
+1. **Validates** version format and checks for uncommitted changes
+2. **Updates** version numbers in:
+   - `src/fips_agents_cli/version.py`
+   - `pyproject.toml`
+3. **Verifies** both files have matching versions
+4. **Commits** changes including README.md (changelog)
+5. **Pushes** to main branch
+6. **Creates** and pushes version tag (e.g., `v0.1.2`)
+7. **Triggers** GitHub Actions workflow for:
+   - Creating GitHub Release
+   - Building distribution packages
+   - Publishing to PyPI
+
+### Prerequisites
+
+- Must be run from project root directory
+- Working directory should be clean (no uncommitted changes except version files)
+- Git remote configured for push access
+- PyPI Trusted Publishing configured on GitHub
+
+### Recommended Usage
+
+Use the `/create-release` slash command in Claude Code, which will:
+1. Ask for version and release notes
+2. Update changelog in README.md
+3. Call this script automatically
+
+### Manual Usage
+
+If you prefer to run manually:
+
+```bash
+# 1. Update changelog in README.md first
+# 2. Run the script
+./scripts/release.sh 0.1.2 "Brief description of changes"
+# 3. Monitor GitHub Actions
+```
+
+### Error Handling
+
+The script will exit with an error if:
+- Version format is invalid
+- Not run from project root
+- Uncommitted changes exist (excluding version files and README)
+- Version verification fails
+- Git operations fail
+
+### Success Output
+
+On success, you'll see:
+- Green checkmarks for each step
+- Links to monitor GitHub Actions
+- Link to view the release
+
+### Monitoring
+
+After running the script, monitor:
+- GitHub Actions: https://github.com/rdwj/fips-agents-cli/actions
+- Releases: https://github.com/rdwj/fips-agents-cli/releases
+- PyPI: https://pypi.org/project/fips-agents-cli/
+
+The entire release process typically takes 1-2 minutes.

fips_agents_cli-0.1.2/scripts/release.sh

@@ -0,0 +1,127 @@
+#!/usr/bin/env bash
+#
+# release.sh - Automated release script for fips-agents-cli
+#
+# Usage: ./scripts/release.sh <version> <commit-message>
+#
+# Example: ./scripts/release.sh 0.1.2 "Add new feature for X"
+#
+
+set -e  # Exit on error
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Function to print colored output
+print_success() {
+    echo -e "${GREEN}✓${NC} $1"
+}
+
+print_error() {
+    echo -e "${RED}✗${NC} $1"
+}
+
+print_info() {
+    echo -e "${YELLOW}ℹ${NC} $1"
+}
+
+# Check arguments
+if [ $# -ne 2 ]; then
+    print_error "Usage: $0 <version> <commit-message>"
+    echo "Example: $0 0.1.2 \"Add new feature for X\""
+    exit 1
+fi
+
+VERSION=$1
+COMMIT_MSG=$2
+
+# Validate version format (x.y.z)
+if ! [[ $VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+    print_error "Invalid version format: $VERSION"
+    echo "Version must be in format: x.y.z (e.g., 0.1.2)"
+    exit 1
+fi
+
+print_info "Preparing release v$VERSION"
+echo
+
+# Check if we're in the project root
+if [ ! -f "pyproject.toml" ] || [ ! -f "src/fips_agents_cli/version.py" ]; then
+    print_error "Must run from project root directory"
+    exit 1
+fi
+
+# Check for uncommitted changes (excluding the files we'll modify)
+if ! git diff --quiet --exit-code -- ':!src/fips_agents_cli/version.py' ':!pyproject.toml' ':!README.md'; then
+    print_error "You have uncommitted changes. Please commit or stash them first."
+    git status --short
+    exit 1
+fi
+
+# 1. Update version.py
+print_info "Updating src/fips_agents_cli/version.py to $VERSION"
+sed -i.bak "s/^__version__ = .*/__version__ = \"$VERSION\"/" src/fips_agents_cli/version.py
+rm -f src/fips_agents_cli/version.py.bak
+print_success "Updated version.py"
+
+# 2. Update pyproject.toml
+print_info "Updating pyproject.toml to $VERSION"
+sed -i.bak "s/^version = .*/version = \"$VERSION\"/" pyproject.toml
+rm -f pyproject.toml.bak
+print_success "Updated pyproject.toml"
+
+# 3. Verify the changes
+print_info "Verifying version updates..."
+VERSION_PY=$(grep -E '^__version__' src/fips_agents_cli/version.py | cut -d'"' -f2)
+VERSION_TOML=$(grep -E '^version' pyproject.toml | head -1 | cut -d'"' -f2)
+
+if [ "$VERSION_PY" != "$VERSION" ] || [ "$VERSION_TOML" != "$VERSION" ]; then
+    print_error "Version verification failed!"
+    echo "  version.py: $VERSION_PY"
+    echo "  pyproject.toml: $VERSION_TOML"
+    echo "  expected: $VERSION"
+    exit 1
+fi
+print_success "Version verification passed"
+
+# 4. Show the changes
+echo
+print_info "Changes to be committed:"
+git diff src/fips_agents_cli/version.py pyproject.toml README.md
+echo
+
+# 5. Commit the changes
+print_info "Committing changes..."
+git add src/fips_agents_cli/version.py pyproject.toml README.md
+git commit -m "Bump version to $VERSION
+
+$COMMIT_MSG"
+print_success "Changes committed"
+
+# 6. Push to main
+print_info "Pushing to main..."
+git push origin main
+print_success "Pushed to main"
+
+# 7. Create and push tag
+print_info "Creating tag v$VERSION..."
+git tag "v$VERSION"
+print_success "Tag created"
+
+print_info "Pushing tag v$VERSION..."
+git push origin "v$VERSION"
+print_success "Tag pushed"
+
+echo
+print_success "Release v$VERSION initiated!"
+echo
+echo "GitHub Actions will now:"
+echo "  1. Create GitHub Release"
+echo "  2. Build distribution packages"
+echo "  3. Publish to PyPI"
+echo
+echo "Monitor progress at: https://github.com/rdwj/fips-agents-cli/actions"
+echo "View release at: https://github.com/rdwj/fips-agents-cli/releases/tag/v$VERSION"

{fips_agents_cli-0.1.1 → fips_agents_cli-0.1.2}/src/fips_agents_cli/version.py

@@ -1,3 +1,3 @@
 """Version information for fips-agents-cli."""
 
-__version__ = "0.1.1"
+__version__ = "0.1.2"