1.1.0

anton-yurchenko · Jul 9, 2023 · ac5d651 · ac5d651
1 parent 40a2625
commit ac5d651
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,20 @@
 # Changelog
 
-## [1.0.5] - 2023-07-18
+## [1.1.0] - 2023-07-09
+
+### Added
+
+- Titles line breakers
+
+### Changed
+
+- Update dependencies
+
+### Fixed
+
+- Null pointer exception upon `CreateReleaseFromUnreleased` / `CreateReleaseFromUnreleasedWithURL` call with an empty `Unreleased` section
+
+## [1.0.5] - 2023-06-18
 
 ### Changed
 
@@ -60,6 +74,7 @@
 
 _Initial release_
 
+[1.1.0]: https://github.com/anton-yurchenko/go-changelog/compare/v1.0.5...v1.1.0
 [1.0.5]: https://github.com/anton-yurchenko/go-changelog/compare/v1.0.4...v1.0.5
 [1.0.4]: https://github.com/anton-yurchenko/go-changelog/compare/v1.0.3...v1.0.4
 [1.0.3]: https://github.com/anton-yurchenko/go-changelog/compare/v1.0.2...v1.0.3

diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ package main
 
 import (
     changelog "github.com/anton-yurchenko/go-changelog"
+    "github.com/spf13/afero"
 )
 
 func main() {
@@ -37,7 +38,7 @@ func main() {
     c.AddUnreleasedChange("fixed", []string{"Bug"})
     c.AddUnreleasedChange("added", []string{"Feature"})
 
-    r, err := c.CreateReleaseFromUnreleased("1.0.0", "https://github.com/anton-yurchenko/go-changelog/releases/tag/v1.0.0", "2021-05-31")
+    r, err := c.CreateReleaseFromUnreleasedWithURL("1.0.0", "2021-05-31","https://github.com/anton-yurchenko/go-changelog/releases/tag/v1.0.0")
     if err != nil {
         panic(err)
     }
@@ -47,7 +48,7 @@ func main() {
     }
     r.AddNotice("**This release contains breaking changes**")
 
-    if err := c.SaveToFile("./CHANGELOG.md"); err != nil {
+    if err := c.SaveToFile(afero.NewOsFs(), "./CHANGELOG.md"); err != nil {
         panic(err)
     }
 }
@@ -87,6 +88,7 @@ package main
 
 import (
     changelog "github.com/anton-yurchenko/go-changelog"
+    "github.com/spf13/afero"
 )
 
 func main() {
@@ -107,7 +109,7 @@ func main() {
 
     r.Yanked = true
 
-    c.SaveToFile("./CHANGELOG.md")
+    c.SaveToFile(afero.NewOsFs(), "./CHANGELOG.md")
     if err != nil {
         panic(err)
     }
@@ -120,6 +122,7 @@ func main() {
 
 - Releases are sorted by their [Semantic Version](https://semver.org/)
 - Scopes are sorted by their importance
+- `SaveToFile` will overwrite the existing file, and anything that does not match the changelog format will be omitted
 
 ## License