Merge pull request #1657 from ksylvan/0727-automated-release-notes

Add GitHub Release Description Update Feature

Author: ksylvan

.github/workflows/release.yml

@@ -122,6 +122,7 @@ jobs:
           else
             echo "Release ${{ env.latest_tag }} already exists."
           fi
+          go run ./cmd/generate_changelog --release ${{ env.latest_tag }}
 
       - name: Upload release artifact
         if: matrix.os == 'windows-latest'

cmd/generate_changelog/README.md

@@ -101,6 +101,7 @@ generate_changelog --cache /path/to/cache.db
 | `--force-pr-sync` | | Force a full PR sync from GitHub | false |
 | `--token` | | GitHub API token | `$GITHUB_TOKEN` |
 | `--ai-summarize` | | Generate AI-enhanced summaries using Fabric | false |
+| `--release` | | Update GitHub release description with AI summary for version | |
 
 ## Output Format
 

cmd/generate_changelog/changelog.db

@@ -0,0 +1,7 @@
+### PR [#1657](https://github.com/danielmiessler/Fabric/pull/1657) by [ksylvan](https://github.com/ksylvan): Add GitHub Release Description Update Feature
+
+- Add GitHub release description update via `--release` flag
+- Implement `ReleaseManager` for managing release descriptions
+- Create `release.go` for handling release updates
+- Update `release.yml` to run changelog generation
+- Enable AI summary updates for GitHub releases

cmd/generate_changelog/incoming/1657.txt

@@ -17,4 +17,5 @@ type Config struct {
 	IncomingDir       string
 	Push              bool
 	SyncDB            bool
+	Release           string
 }

cmd/generate_changelog/internal/config/config.go

@@ -0,0 +1,81 @@
+package internal
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/danielmiessler/fabric/cmd/generate_changelog/internal/cache"
+	"github.com/danielmiessler/fabric/cmd/generate_changelog/internal/config"
+	"github.com/google/go-github/v66/github"
+	"golang.org/x/oauth2"
+)
+
+type ReleaseManager struct {
+	cache       *cache.Cache
+	githubToken string
+	owner       string
+	repo        string
+}
+
+func NewReleaseManager(cfg *config.Config) (*ReleaseManager, error) {
+	cache, err := cache.New(cfg.CacheFile)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create cache: %w", err)
+	}
+
+	return &ReleaseManager{
+		cache:       cache,
+		githubToken: cfg.GitHubToken,
+		owner:       "danielmiessler",
+		repo:        "fabric",
+	}, nil
+}
+
+func (rm *ReleaseManager) Close() error {
+	return rm.cache.Close()
+}
+
+func (rm *ReleaseManager) UpdateReleaseDescription(version string) error {
+	versions, err := rm.cache.GetVersions()
+	if err != nil {
+		return fmt.Errorf("failed to get versions from cache: %w", err)
+	}
+
+	versionData, exists := versions[version]
+	if !exists {
+		return fmt.Errorf("version %s not found in versions table", version)
+	}
+
+	if versionData.AISummary == "" {
+		return fmt.Errorf("ai_summary is empty for version %s", version)
+	}
+
+	releaseBody := fmt.Sprintf("## Changes\n\n%s", versionData.AISummary)
+
+	ctx := context.Background()
+	var client *github.Client
+
+	if rm.githubToken != "" {
+		ts := oauth2.StaticTokenSource(
+			&oauth2.Token{AccessToken: rm.githubToken},
+		)
+		tc := oauth2.NewClient(ctx, ts)
+		client = github.NewClient(tc)
+	} else {
+		client = github.NewClient(nil)
+	}
+
+	release, _, err := client.Repositories.GetReleaseByTag(ctx, rm.owner, rm.repo, version)
+	if err != nil {
+		return fmt.Errorf("failed to get release for version %s: %w", version, err)
+	}
+
+	release.Body = &releaseBody
+	_, _, err = client.Repositories.EditRelease(ctx, rm.owner, rm.repo, *release.ID, release)
+	if err != nil {
+		return fmt.Errorf("failed to update release description for version %s: %w", version, err)
+	}
+
+	fmt.Printf("Successfully updated release description for %s\n", version)
+	return nil
+}

cmd/generate_changelog/internal/release.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"path/filepath"
 
+	internal "github.com/danielmiessler/fabric/cmd/generate_changelog/internal"
 	"github.com/danielmiessler/fabric/cmd/generate_changelog/internal/changelog"
 	"github.com/danielmiessler/fabric/cmd/generate_changelog/internal/config"
 	"github.com/joho/godotenv"
@@ -42,13 +43,18 @@ func init() {
 	rootCmd.Flags().StringVar(&cfg.IncomingDir, "incoming-dir", "./cmd/generate_changelog/incoming", "Directory for incoming PR files")
 	rootCmd.Flags().BoolVar(&cfg.Push, "push", false, "Enable automatic git push after creating an incoming entry")
 	rootCmd.Flags().BoolVar(&cfg.SyncDB, "sync-db", false, "Synchronize and validate database integrity with git history and GitHub PRs")
+	rootCmd.Flags().StringVar(&cfg.Release, "release", "", "Update GitHub release description with AI summary for version (e.g., v1.2.3)")
 }
 
 func run(cmd *cobra.Command, args []string) error {
 	if cfg.IncomingPR > 0 && cfg.ProcessPRsVersion != "" {
 		return fmt.Errorf("--incoming-pr and --process-prs are mutually exclusive flags")
 	}
 
+	if cfg.Release != "" && (cfg.IncomingPR > 0 || cfg.ProcessPRsVersion != "" || cfg.SyncDB) {
+		return fmt.Errorf("--release cannot be used with other processing flags")
+	}
+
 	if cfg.GitHubToken == "" {
 		cfg.GitHubToken = os.Getenv("GITHUB_TOKEN")
 	}
@@ -70,6 +76,15 @@ func run(cmd *cobra.Command, args []string) error {
 		return generator.SyncDatabase()
 	}
 
+	if cfg.Release != "" {
+		releaseManager, err := internal.NewReleaseManager(cfg)
+		if err != nil {
+			return fmt.Errorf("failed to create release manager: %w", err)
+		}
+		defer releaseManager.Close()
+		return releaseManager.UpdateReleaseDescription(cfg.Release)
+	}
+
 	output, err := generator.Generate()
 	if err != nil {
 		return fmt.Errorf("failed to generate changelog: %w", err)