feat: update changelog (#131)
closes #130 - CHANGELOG.md file for people who can view changelog from github --- `iris changelog` command: `iris changelog [version]` (e.g. iris changelog v0.5.1) `iris changelog -n 3` (see changelog of 3 latest releaseas) => `iris changelog` looks just like CHANGELOG.md, grouped headers and all. It only stops looking that way if we personally overwrite that release's description with something else => With 1-hour local cache (invalidated on updater-channel change), `--refresh` flag to bypass, graceful fallback to stale cache on GitHub rate-limiting --- - New auto update config ```toml # 0 = off (default, notify only), 1 = auto-install, 2 = always confirm first auto-update = 1 ``` - New just debug-changelog and just debug-autoupdate recipes (fully offline, mocked HTTP servers, no real network/config touched)
This commit is contained in:
VERSE
@@ -0,0 +1,312 @@
|
||||
package root
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/charmbracelet/glamour"
|
||||
"github.com/charmbracelet/x/ansi"
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/versenilvis/iris/internal/config"
|
||||
"golang.org/x/term"
|
||||
)
|
||||
|
||||
type Release struct {
|
||||
TagName string `json:"tag_name"`
|
||||
PublishedAt time.Time `json:"published_at"`
|
||||
Body string `json:"body"`
|
||||
Prerelease bool `json:"prerelease"`
|
||||
}
|
||||
|
||||
type changelogCache struct {
|
||||
FetchedAt time.Time `json:"fetched_at"`
|
||||
Channel string `json:"channel"`
|
||||
Releases []Release `json:"releases"`
|
||||
}
|
||||
|
||||
const changelogCacheTTL = time.Hour
|
||||
|
||||
func changelogCachePath() (string, error) {
|
||||
dir, err := config.CachePath()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return filepath.Join(dir, "changelog-cache.json"), nil
|
||||
}
|
||||
|
||||
func loadChangelogCache() (*changelogCache, error) {
|
||||
path, err := changelogCachePath()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var cache changelogCache
|
||||
if err := json.Unmarshal(data, &cache); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &cache, nil
|
||||
}
|
||||
|
||||
func saveChangelogCache(releases []Release) {
|
||||
path, err := changelogCachePath()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
data, err := json.Marshal(changelogCache{FetchedAt: time.Now(), Channel: config.Get().Updater.Channel, Releases: releases})
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
_ = os.MkdirAll(filepath.Dir(path), 0o755)
|
||||
_ = os.WriteFile(path, data, 0o644)
|
||||
}
|
||||
|
||||
func FetchReleases(limit int) ([]Release, error) {
|
||||
ctx, cancel := newGitHubRequestContext()
|
||||
defer cancel()
|
||||
|
||||
endpoint := os.Getenv("IRIS_CHANGELOG_URL")
|
||||
if endpoint == "" {
|
||||
endpoint = "https://api.github.com/repos/versenilvis/iris/releases?per_page=100"
|
||||
}
|
||||
|
||||
body, err := fetchGitHubBody(ctx, endpoint)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var releases []Release
|
||||
if err := json.Unmarshal(body, &releases); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if config.Get().Updater.Channel != "nightly" {
|
||||
filtered := releases[:0]
|
||||
for _, r := range releases {
|
||||
if !r.Prerelease {
|
||||
filtered = append(filtered, r)
|
||||
}
|
||||
}
|
||||
releases = filtered
|
||||
}
|
||||
|
||||
return truncateReleases(releases, limit), nil
|
||||
}
|
||||
|
||||
func truncateReleases(releases []Release, limit int) []Release {
|
||||
if limit > 0 && len(releases) > limit {
|
||||
return releases[:limit]
|
||||
}
|
||||
return releases
|
||||
}
|
||||
|
||||
// falls back to a stale cache rather than failing outright when rate limited
|
||||
func FetchReleasesCached(limit int, refresh bool) (releases []Release, rateLimited bool, err error) {
|
||||
channel := config.Get().Updater.Channel
|
||||
|
||||
if !refresh {
|
||||
if cache, cacheErr := loadChangelogCache(); cacheErr == nil && cache.Channel == channel && time.Since(cache.FetchedAt) < changelogCacheTTL {
|
||||
return truncateReleases(cache.Releases, limit), false, nil
|
||||
}
|
||||
}
|
||||
|
||||
fresh, fetchErr := FetchReleases(100)
|
||||
if fetchErr != nil {
|
||||
if errors.Is(fetchErr, ErrRateLimited) {
|
||||
if cache, cacheErr := loadChangelogCache(); cacheErr == nil && cache.Channel == channel && len(cache.Releases) > 0 {
|
||||
return truncateReleases(cache.Releases, limit), true, nil
|
||||
}
|
||||
}
|
||||
return nil, false, fetchErr
|
||||
}
|
||||
|
||||
saveChangelogCache(fresh)
|
||||
return truncateReleases(fresh, limit), false, nil
|
||||
}
|
||||
|
||||
func releaseURL(tag string) string {
|
||||
return "https://github.com/versenilvis/iris/releases/tag/" + tag
|
||||
}
|
||||
|
||||
var (
|
||||
changelogRenderer *glamour.TermRenderer
|
||||
changelogRendererOnce sync.Once
|
||||
errChangelogRenderer error
|
||||
)
|
||||
|
||||
func changelogRenderWidth() int {
|
||||
if w, _, err := term.GetSize(int(os.Stdout.Fd())); err == nil && w > 0 && w < 120 {
|
||||
return w
|
||||
}
|
||||
return 120
|
||||
}
|
||||
|
||||
func renderChangelogMarkdown(body string) (string, error) {
|
||||
changelogRendererOnce.Do(func() {
|
||||
changelogRenderer, errChangelogRenderer = glamour.NewTermRenderer(
|
||||
glamour.WithStandardStyle("dark"),
|
||||
glamour.WithWordWrap(changelogRenderWidth()),
|
||||
)
|
||||
})
|
||||
if errChangelogRenderer != nil {
|
||||
return "", errChangelogRenderer
|
||||
}
|
||||
return changelogRenderer.Render(body)
|
||||
}
|
||||
|
||||
func stripRedundantHeading(body string) string {
|
||||
lines := strings.Split(body, "\n")
|
||||
filtered := lines[:0]
|
||||
for _, line := range lines {
|
||||
if strings.TrimSpace(line) == "## Changelog" {
|
||||
continue
|
||||
}
|
||||
filtered = append(filtered, line)
|
||||
}
|
||||
return strings.Join(filtered, "\n")
|
||||
}
|
||||
|
||||
// judged post-strip: glamour's margin padding has color codes but no glyphs
|
||||
func isBlankLine(line string) bool {
|
||||
return strings.TrimSpace(ansi.Strip(line)) == ""
|
||||
}
|
||||
|
||||
func squeezeBlankLines(s string) string {
|
||||
lines := strings.Split(s, "\n")
|
||||
out := make([]string, 0, len(lines))
|
||||
prevBlank := false
|
||||
for _, line := range lines {
|
||||
blank := isBlankLine(line)
|
||||
if blank && prevBlank {
|
||||
continue
|
||||
}
|
||||
out = append(out, line)
|
||||
prevBlank = blank
|
||||
}
|
||||
return strings.Join(out, "\n")
|
||||
}
|
||||
|
||||
func trimBlankLines(s string) string {
|
||||
lines := strings.Split(s, "\n")
|
||||
start := 0
|
||||
for start < len(lines) && isBlankLine(lines[start]) {
|
||||
start++
|
||||
}
|
||||
end := len(lines)
|
||||
for end > start && isBlankLine(lines[end-1]) {
|
||||
end--
|
||||
}
|
||||
return strings.Join(lines[start:end], "\n")
|
||||
}
|
||||
|
||||
// the CTA is rendered separately by printRelease based on IsNewer, so the
|
||||
// GoReleaser footer is cut before handing the body to glamour
|
||||
func printChangelogBody(out io.Writer, body string) {
|
||||
if idx := strings.Index(body, "## Update"); idx != -1 {
|
||||
body = body[:idx]
|
||||
}
|
||||
body = strings.TrimSpace(stripRedundantHeading(body))
|
||||
if body == "" {
|
||||
return
|
||||
}
|
||||
|
||||
rendered, err := renderChangelogMarkdown(body)
|
||||
if err != nil {
|
||||
fmt.Fprintln(out, body)
|
||||
return
|
||||
}
|
||||
fmt.Fprintln(out, trimBlankLines(squeezeBlankLines(rendered)))
|
||||
}
|
||||
|
||||
func printRelease(out io.Writer, release Release, showUpdateCTA bool) {
|
||||
label := release.TagName
|
||||
if strings.TrimPrefix(release.TagName, "v") == strings.TrimPrefix(Version, "v") {
|
||||
label += " (current)"
|
||||
}
|
||||
|
||||
date := release.PublishedAt.Format("2006-01-02")
|
||||
fmt.Fprintf(out, "\033[1;36mIRIS %s - %s\033[0m\n", label, date)
|
||||
fmt.Fprintf(out, "\033[2m%s\033[0m\n\n", releaseURL(release.TagName))
|
||||
|
||||
printChangelogBody(out, release.Body)
|
||||
|
||||
if showUpdateCTA && IsNewer(Version, release.TagName) {
|
||||
fmt.Fprintln(out)
|
||||
fmt.Fprintln(out, "run `iris update` to install")
|
||||
}
|
||||
}
|
||||
|
||||
var (
|
||||
changelogCount int
|
||||
changelogRefresh bool
|
||||
)
|
||||
|
||||
var ChangelogCmd = &cobra.Command{
|
||||
Use: "changelog [version]",
|
||||
Short: "show what changed in recent iris releases",
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
limit := changelogCount
|
||||
if len(args) == 1 {
|
||||
limit = 0 // searching a specific version, not just the most recent N
|
||||
}
|
||||
|
||||
releases, rateLimited, err := FetchReleasesCached(limit, changelogRefresh)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrRateLimited) {
|
||||
fmt.Fprintln(cmd.ErrOrStderr(), "\033[31m[IRIS] rate limited by GitHub API, try again later\033[0m")
|
||||
return
|
||||
}
|
||||
fmt.Fprintf(cmd.ErrOrStderr(), "\033[31m[IRIS] could not fetch changelog: %v\033[0m\n", err)
|
||||
return
|
||||
}
|
||||
if len(releases) == 0 {
|
||||
cmd.Println("no releases found")
|
||||
return
|
||||
}
|
||||
|
||||
out := cmd.OutOrStdout()
|
||||
|
||||
if len(args) == 1 {
|
||||
target := strings.TrimPrefix(args[0], "v")
|
||||
for _, release := range releases {
|
||||
if strings.TrimPrefix(release.TagName, "v") == target {
|
||||
printRelease(out, release, true)
|
||||
if rateLimited {
|
||||
fmt.Fprintln(out)
|
||||
fmt.Fprintln(out, "\033[33m[IRIS] rate limited by GitHub API, showing cached data\033[0m")
|
||||
}
|
||||
return
|
||||
}
|
||||
}
|
||||
fmt.Fprintf(cmd.ErrOrStderr(), "\033[31m[IRIS] release %s not found\033[0m\n", args[0])
|
||||
return
|
||||
}
|
||||
|
||||
for i, release := range releases {
|
||||
if i > 0 {
|
||||
fmt.Fprintln(out)
|
||||
}
|
||||
printRelease(out, release, i == 0)
|
||||
}
|
||||
if rateLimited {
|
||||
fmt.Fprintln(out)
|
||||
fmt.Fprintln(out, "\033[33m[IRIS] rate limited by GitHub API, showing cached data\033[0m")
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
ChangelogCmd.Flags().IntVarP(&changelogCount, "count", "n", 1, "number of releases to show")
|
||||
ChangelogCmd.Flags().BoolVar(&changelogRefresh, "refresh", false, "bypass the cache and fetch fresh data")
|
||||
rootCmd.AddCommand(ChangelogCmd)
|
||||
}
|
||||
Reference in New Issue
Block a user