Add a latest command that shows the latest released version

.github/workflows/golangci-lint.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   golangci:
@@ -14,10 +14,10 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v1
+        uses: golangci/golangci-lint-action@v2
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.26
+          version: v1.29
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
           # Optional: golangci-lint command line arguments.

.github/workflows/goreleaser.yml

@@ -1,15 +1,15 @@
 name: goreleaser
 
 on:
-  pull_request:
+  pull_request
   push:
     branches:
-      - master
+      - main
     tags:
       - "[0-9]+.[0-9]+.[0-9]+"
 
 jobs:
-  goreleaser:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -24,25 +24,27 @@ jobs:
           go-version: 1.14
 
       - name: Build
-        # if: "!startsWith(github.ref, 'refs/tags/')"
         uses: goreleaser/goreleaser-action@v2
         with:
           version: latest
           args: build --snapshot --rm-dist
 
-      - name: Prepare release notes
-        if: "startsWith(github.ref, 'refs/tags/')"
-        run: ./dist/changelog_linux_amd64/changelog -f CHANGELOG.md show ${GITHUB_REF##*/} > release-notes.txt
-
-      - name: Docker login
-        if: "startsWith(github.ref, 'refs/tags/')"
-        run: docker login -u '${{ secrets.DOCKER_USERNAME }}' -p '${{ secrets.DOCKER_PASSWORD }}'
-
-      - name: Release
-        uses: goreleaser/goreleaser-action@v2
-        if: "startsWith(github.ref, 'refs/tags/')"
-        with:
-          version: latest
-          args: release --release-notes release-notes.txt --rm-dist
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    release:
+      runs-on: ubuntu-latest
+      environment: Release
+      needs: build
+      if: "startsWith(github.ref, 'refs/tags/')"
+      steps:
+        - name: Prepare release notes
+          run: ./dist/changelog_linux_amd64/changelog -f CHANGELOG.md show ${GITHUB_REF##*/} > release-notes.txt
+
+        - name: Docker login
+          run: docker login -u '${{ secrets.DOCKER_HUB_USER }}' -p '${{ secrets.DOCKER_HUB_PASSWORD }}'
+
+        - name: Release
+          uses: goreleaser/goreleaser-action@v2
+          with:
+            version: latest
+            args: release --release-notes release-notes.txt --rm-dist
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -20,3 +20,4 @@ release-notes.txt
 
 
 # End of https://www.gitignore.io/api/go
+.idea/

.golangci.yml

@@ -6,9 +6,9 @@ linters:
     - gas
     - gocyclo
     - megacheck
+    - goimports
   enable:
     - gofmt
-    - goimports
     - gosimple
     - unused
     - staticcheck

.goreleaser.yml

@@ -7,16 +7,13 @@ builds:
       - linux
     goarch:
       - amd64
+      - arm64
 dockers:
   - goos: linux
     goarch: amd64
-    builds:
-      - changelog
-    binaries:
-      - changelog
     dockerfile: Dockerfile.goreleaser
     image_templates:
-      - "rcmachado/{{.ProjectName}}:{{.Tag}}"
-      - "rcmachado/{{.ProjectName}}:{{ .Major }}"
-      - "rcmachado/{{.ProjectName}}:{{ .Major }}.{{ .Minor }}"
-      - "rcmachado/{{.ProjectName}}:latest"
+      - "cucumber/{{.ProjectName}}:{{.Tag}}"
+      - "cucumber/{{.ProjectName}}:{{ .Major }}"
+      - "cucumber/{{.ProjectName}}:{{ .Major }}.{{ .Minor }}"
+      - "cucumber/{{.ProjectName}}:latest"

CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.10.0] - 2021-11-11
+### Added
+- `latest` command to show latest release version number ([#5](https://github.com/cucumber/changelog/pull/5))
+
+## [0.9.2] - 2021-11-11
+### Added
+- ARM64 release build
+
+### Fixed
+- config for releasing to Cucumber's docker account
+
+## 0.9.1 - 2021-11-11
+
+## [0.9.0] - 2021-11-11
+### Fixed
+- Show command was broken ([#4](https://github.com/cucumber/changelog/issues/4))
+
+## [0.8.0] - 2021-11-11
+### Added
+- Add `--json` flag to `fmt` and `show` commands. ([#1](https://github.com/cucumber/changelog/pull/1))
+- Add `--tag-format` to `release` command. ([#2](https://github.com/cucumber/changelog/pull/2))
+
 ## [0.7.0] - 2020-07-03
 ### Changed
 - Install git and openssh on docker image
@@ -61,7 +83,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `fmt` command to reformat changelog following the spec
 - `show` command to show a specific version
 
-[Unreleased]: https://github.com/rcmachado/changelog/compare/0.7.0...HEAD
+[Unreleased]: https://github.com/rcmachado/changelog/compare/0.10.0...HEAD
+[0.10.0]: https://github.com/rcmachado/changelog/compare/0.9.2...0.10.0
+[0.9.2]: https://github.com/rcmachado/changelog/compare/0.9.0...0.9.2
+[0.9.0]: https://github.com/rcmachado/changelog/compare/0.8.0...0.9.0
+[0.8.0]: https://github.com/rcmachado/changelog/compare/0.7.0...0.8.0
 [0.7.0]: https://github.com/rcmachado/changelog/compare/0.6.0...0.7.0
 [0.6.0]: https://github.com/rcmachado/changelog/compare/0.5.0...0.6.0
 [0.5.0]: https://github.com/rcmachado/changelog/compare/0.4.2...0.5.0

README.md

@@ -1,8 +1,10 @@
 # changelog
 
-![Tests](https://github.com/rcmachado/changelog/workflows/Tests/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/rcmachado/changelog/badge.svg?branch=master)](https://coveralls.io/github/rcmachado/changelog?branch=master)
-[![Go Report Card](https://goreportcard.com/badge/github.com/rcmachado/changelog)](https://goreportcard.com/report/github.com/rcmachado/changelog)
+![Tests](https://github.com/cucumber/changelog/workflows/Tests/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/cucumber/changelog/badge.svg?branch=master)](https://coveralls.io/github/cucumber/changelog?branch=master)
+[![Go Report Card](https://goreportcard.com/badge/github.com/cucumber/changelog)](https://goreportcard.com/report/github.com/cucumber/changelog)
+
+(This is a fork of https://github.com/rcmachado/changelog)
 
 `changelog` is a command-line application to read and manipulate
 `CHANGELOG.md` files that follows the [keepachangelog.com][] spec.
@@ -34,6 +36,9 @@ $ changelog init --compare-url=https://github.com/myorg/myrepo/compare/abcdef...
 $ changelog added "Initial commit"
 # Create release
 $ changelog release 0.1.0
+# Show latest release number
+$ changelog latest
+=> 0.1.0
 ```
 
 ## Installation
@@ -76,6 +81,7 @@ Available Commands:
   fmt         Reformat the change log file
   help        Help about any command
   init        Initializes a new changelog
+  latest      Show latest released version number
   release     Change Unreleased to [version]
   removed     Add item under 'Removed' section
   security    Add item under 'Security' section
@@ -95,7 +101,7 @@ Outputs a changelog with only preamble and Unreleased version to standard output
 
 ```bash
 $ touch CHANGELOG.md
-$ changelog init -o CHANGELOG.md --compare-url https://github.com/rcmachado/changelog/compare/abcdef...HEAD
+$ changelog init -o CHANGELOG.md --compare-url https://github.com/cucumber/changelog/compare/abcdef...HEAD
 Changelog file 'CHANGELOG.md' created.
 ```
 
@@ -130,6 +136,12 @@ Create a new release:
 changelog release 1.2.4
 ```
 
+If you use a prefix for git tags, specify a tag format:
+
+```bash
+changelog release --tag-format "v%s" 1.2.4
+```
+
 ### Formatting
 
 `fmt` command normalizes the changelog file. The idea is to always have
@@ -153,5 +165,5 @@ Licensed under MIT. See [LICENSE][] file for details.
 
 [keepachangelog.com]: https://keepachangelog.com/
 [LICENSE]: ./LICENSE
-[Issues]: https://github.com/rcmachado/changelog
-[latest version]: https://github.com/rcmachado/changelog/releases/latest
+[Issues]: https://github.com/cucumber/changelog
+[latest version]: https://github.com/cucumber/changelog/releases/latest

chg/change.go

@@ -3,6 +3,7 @@ package chg
 //go:generate stringer -type=ChangeType
 
 import (
+	"encoding/json"
 	"fmt"
 	"io"
 	"strings"
@@ -16,6 +17,16 @@ type ChangeList struct {
 	Items []*Item
 }
 
+func (cl *ChangeList) MarshalJSON() ([]byte, error) {
+	return json.Marshal(&struct {
+		Type  string  `json:"type"`
+		Items []*Item `json:"items"`
+	}{
+		Type:  ChangeStringFromType(cl.Type),
+		Items: cl.Items,
+	})
+}
+
 // ChangeType is the type of the changes
 type ChangeType int
 
@@ -30,6 +41,26 @@ const (
 	Security
 )
 
+// ChangeTypeFromString creates a type based on its string name
+func ChangeStringFromType(ct ChangeType) string {
+	switch ct {
+	case Added:
+		return "added"
+	case Changed:
+		return "changed"
+	case Deprecated:
+		return "deprecated"
+	case Fixed:
+		return "fixed"
+	case Removed:
+		return "removed"
+	case Security:
+		return "security"
+	default:
+		return "unknown"
+	}
+}
+
 // ChangeTypeFromString creates a type based on its string name
 func ChangeTypeFromString(ct string) ChangeType {
 	switch strings.ToLower(ct) {

chg/changelog.go

@@ -11,8 +11,8 @@ import (
 // Changelog is the main struct that holds all the data
 // in a format specific to the spec
 type Changelog struct {
-	Preamble string
-	Versions []*Version
+	Preamble string     `json:"preamble"`
+	Versions []*Version `json:"versions"`
 }
 
 // NewChangelog creates the Changelog struct
@@ -78,7 +78,7 @@ func (c *Changelog) AddItem(section ChangeType, message string) {
 }
 
 // Release transforms Unreleased into the version informed
-func (c *Changelog) Release(newVersion Version) (*Version, error) {
+func (c *Changelog) Release(newVersion Version, tagFormat string) (*Version, error) {
 	oldUnreleased := c.Version("Unreleased")
 	var prevVersion *Version
 	if len(c.Versions) > 1 {
@@ -101,17 +101,17 @@ func (c *Changelog) Release(newVersion Version) (*Version, error) {
 		compareURL = strings.Replace(newVersion.Link, "<prev>", newVersion.Name, -1)
 		compareURL = strings.Replace(compareURL, "<next>", "HEAD", -1)
 	} else if prevVersion == nil || prevVersion.Link == "" {
-		r := regexp.MustCompile(`(\w[\w\.]*?)\.{2,3}(\w[\w\.]*?)$`)
+		r := regexp.MustCompile(`(\w[\w.]*?)\.{2,3}(\w[\w.]*?)$`)
 		r.MatchString(oldUnreleased.Link)
 		matches := r.FindStringSubmatch(oldUnreleased.Link)
-		compareURL = strings.Replace(oldUnreleased.Link, matches[1], newVersion.Name, -1)
+		compareURL = strings.Replace(oldUnreleased.Link, matches[1], fmt.Sprintf(tagFormat, newVersion.Name), -1)
 	} else {
-		compareURL = strings.Replace(oldUnreleased.Link, prevVersion.Name, newVersion.Name, -1)
+		compareURL = strings.Replace(oldUnreleased.Link, fmt.Sprintf(tagFormat, prevVersion.Name), fmt.Sprintf(tagFormat, newVersion.Name), -1)
 	}
 
 	newUnreleased.Link = compareURL
 
-	oldUnreleased.Link = strings.Replace(oldUnreleased.Link, "HEAD", newVersion.Name, -1)
+	oldUnreleased.Link = strings.Replace(oldUnreleased.Link, "HEAD", fmt.Sprintf(tagFormat, newVersion.Name), -1)
 	oldUnreleased.Name = newVersion.Name
 	oldUnreleased.Date = newVersion.Date
 
@@ -150,3 +150,13 @@ func (c *Changelog) Render(w io.Writer) {
 		w.Write(content)
 	}
 }
+
+func (c *Changelog) ReleasedVersions() []Version {
+	var result []Version
+	for _, version := range c.Versions {
+		if version.Name != "Unreleased" {
+			result = append(result, *version)
+		}
+	}
+	return result
+}