ghrcooldown

A CLI tool and Go library to fetch the latest GitHub Releases respecting the cooldown period.

Usage as a CLI tool

$ ghrcooldown latest --repo hashicorp/terraform --cooldown-days 7
v1.14.8

$ ghrcooldown has-passed --repo hashicorp/terraform --tag v1.14.8 --cooldown-days 7
Cooldown has passed.

Install

Download latest binary from https://github.com/sue445/ghrcooldown/releases

or

go install github.com/sue445/ghrcooldown/cmd/ghrcooldown@latest

Commands

ghrcooldown latest

$ ghrcooldown latest --help
NAME:
   ghrcooldown latest - Print latest release version of the specified repository, respecting the provided cooldown period.

USAGE:
   ghrcooldown latest [options]

OPTIONS:
   --cooldown-days int      Cooldown days (default: 0)
   --github-api-url string  GitHub API Endpoint (e.g. https://<your-ghes-hostname>/api/v3). Required if using GitHub Enterprise Server [$GITHUB_API_URL]
   --repo string            GitHub Repository Path (e.g. user/repo)
   --token string           GitHub token [$GITHUB_TOKEN]
   --help, -h               show help

ghrcooldown has-passed

$ ./bin/ghrcooldown has-passed --help
NAME:
   ghrcooldown has-passed - Checks whether the specified tag has passed the given cooldown period.

USAGE:
   ghrcooldown has-passed [options]

OPTIONS:
   --cooldown-days int      Cooldown days (default: 0)
   --exit-code              Exit with code 1 if the cooldown has not passed (default: false)
   --github-api-url string  GitHub API Endpoint (e.g. https://<your-ghes-hostname>/api/v3). Required if using GitHub Enterprise Server [$GITHUB_API_URL]
   --repo string            GitHub Repository Path (e.g. user/repo)
   --tag string             GitHub tag
   --token string           GitHub token [$GITHUB_TOKEN]
   --help, -h               show help

About --token

--token is the personal access token used for authenticating with the GitHub API.

It is optional, but if omitted, the API request will be subject to IP-based rate limiting.

c.f. https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api

Usage as a library

Install

go get -u github.com/sue445/ghrcooldown

Example

package main

import (
	"context"
	"fmt"
	"log"
	"os"
	"time"

	"github.com/sue445/ghrcooldown"
)

func main() {
	// Initialize the client
	client, err := ghrcooldown.NewClient(&ghrcooldown.ClientParams{
		Token: os.Getenv("GITHUB_TOKEN"),
		// BaseURL: "", // Required if using GitHub Enterprise Server
	})

	// 7 days
	cooldown := 7 * 24 * time.Hour

	ctx := context.Background()

	// Example 1: Returns the latest tagName that has passed the 7-day cooldown period.
	tagName, err := client.GetLatestTagName(ctx, "hashicorp", "terraform", cooldown)
	if err != nil {
		log.Fatalf("failed to get latest tag: %v", err)
	}
	fmt.Printf("Latest tag: %s\n", tagName)

	// Example 2: Returns true if the cooldown has passed.
	hasPassed, err := client.HasCooldownPassed(ctx, "hashicorp", "terraform", "v1.14.8", cooldown)
	if err != nil {
		log.Fatalf("failed to check cooldown: %v", err)
	}
	fmt.Printf("Has v1.14.8 passed the cooldown? %v\n", hasPassed)
}

Reference

https://godoc.org/github.com/sue445/ghrcooldown