From e56f454291b433f008336570689beec3216d6299 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20L=C3=B6nnblad?= Date: Thu, 15 Oct 2020 17:29:33 +0200 Subject: [PATCH] Created release notes and changelog for v0.11.0 --- CHANGELOG.md | 38 ++++++++++++++++++++++++--- README.md | 4 +-- godog.go | 2 +- release-notes/v0.10.0.md | 2 +- release-notes/v0.11.0.md | 57 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 96 insertions(+), 7 deletions(-) create mode 100644 release-notes/v0.11.0.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 830cb98..4892ed1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,34 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt ### Fixed +## [v0.11.0-rc1] + +### Added +- Created a simple example for a custom formatter ([330](https://github.com/cucumber/godog/pull/330) - [lonnblad]) +- --format junit:result.xml will now write to result.xml ([331](https://github.com/cucumber/godog/pull/331) - [lonnblad]) +- Added make commands to create artifacts and upload them to a github release ([333](https://github.com/cucumber/godog/pull/333) - [lonnblad]) + +### Changed +- Added Cobra for the Command Line Interface ([321](https://github.com/cucumber/godog/pull/321) - [lonnblad]) +- Added internal packages for formatters, storage and models ([323](https://github.com/cucumber/godog/pull/323) - [lonnblad]) +- Added an internal package for tags filtering ([326](https://github.com/cucumber/godog/pull/326) - [lonnblad]) +- Added an internal pkg for the builder ([327](https://github.com/cucumber/godog/pull/327) - [lonnblad]) +- Moved the parser code to a new internal pkg ([329](https://github.com/cucumber/godog/pull/329) - [lonnblad]) +- Moved StepDefinition to the formatters pkg ([332](https://github.com/cucumber/godog/pull/332) - [lonnblad]) + +### Deprecated + +### Removed +- Removed deprecated code ([322](https://github.com/cucumber/godog/pull/322) - [lonnblad]) + +### Fixed +- Improved the help text of the formatter flag in the run command ([347](https://github.com/cucumber/godog/pull/347) - [lonnblad]) +- Removed $GOPATH from the README.md and updated the example ([349](https://github.com/cucumber/godog/pull/349) - [lonnblad]) +- Fixed the undefined step definitions help ([350](https://github.com/cucumber/godog/pull/350) - [lonnblad]) +- Added a comment regarding running the examples within the $GOPATH ([352](https://github.com/cucumber/godog/pull/352) - [lonnblad]) +- doc(FAQ/TestMain): `testing.M.Run()` is optional ([353](https://github.com/cucumber/godog/pull/353) - [hansbogert]) +- Made a fix for the unstable Randomize Run tests ([354](https://github.com/cucumber/godog/pull/354) - [lonnblad]) + ## [v0.10.0] ### Added @@ -126,9 +154,12 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt ### Fixed -[Unreleased]: https://github.com/cucumber/cucumber/compare/godog/v0.8.1...master -[0.8.0]: https://github.com/cucumber/cucumber/compare/godog/v0.8.0...godog/v0.8.1 -[0.8.0]: https://github.com/cucumber/cucumber/compare/godog/v0.7.13...godog/v0.8.0 +[Unreleased]: https://github.com/cucumber/godog/compare/v0.11.0-rc1...master +[v0.11.0-rc1]: https://github.com/cucumber/godog/compare/v0.10.0...v0.11.0-rc1 +[v0.10.0]: https://github.com/cucumber/godog/compare/v0.9.0...v0.10.0 +[0.9.0]: https://github.com/cucumber/godog/compare/v0.8.1...v0.9.0 +[0.8.1]: https://github.com/cucumber/godog/compare/v0.8.0...v0.8.1 +[0.8.0]: https://github.com/cucumber/godog/compare/v0.7.13...v0.8.0 [axw]: https://github.com/axw @@ -140,3 +171,4 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt [titouanfreville]: https://github.com/titouanfreville [denis-trofimov]: https://github.com/denis-trofimov [leviable]: https://github.com/leviable +[hansbogert]: https://github.com/hansbogert diff --git a/README.md b/README.md index 8895f43..0d317ec 100644 --- a/README.md +++ b/README.md @@ -343,10 +343,10 @@ var opts = godog.Options{ } func init() { - // godog v0.10.0 (latest) and earlier + // godog v0.10.0 and earlier godog.BindFlags("godog.", flag.CommandLine, &opts) - // godog v0.11.0 + // godog v0.11.0-rc1 (latest) godog.BindCommandLineFlags("godog.", &opts) } diff --git a/godog.go b/godog.go index d3bdb96..f7d158f 100644 --- a/godog.go +++ b/godog.go @@ -39,4 +39,4 @@ Godog was inspired by Behat and Cucumber the above description is taken from it' package godog // Version of package - based on Semantic Versioning 2.0.0 http://semver.org/ -const Version = "v0.10.0" +const Version = "v0.11.0-rc1" diff --git a/release-notes/v0.10.0.md b/release-notes/v0.10.0.md index 9d6acd6..865d691 100644 --- a/release-notes/v0.10.0.md +++ b/release-notes/v0.10.0.md @@ -40,7 +40,7 @@ Non Backward Compatible Changes ------------------------------- ### Hooks -`BeforeFeature` and `AfterFeature` hooks are now removed since the deprecation in `v0.9.0`. +`BeforeFeature` and `AfterFeature` hooks are now removed since the deprecation in [v0.9.0](./v0.9.0.md). Deprecation Notices diff --git a/release-notes/v0.11.0.md b/release-notes/v0.11.0.md new file mode 100644 index 0000000..3b560a3 --- /dev/null +++ b/release-notes/v0.11.0.md @@ -0,0 +1,57 @@ +I am excited to announce the release of godog v0.11.0-rc1. + +Here follows a summary of Notable Changes, the Non Backward Compatible Changes and Deprecation Notices. +The full change log is available [here](https://github.com/cucumber/godog/blob/master/CHANGELOG.md#v0110-rc1). + + +Notable Changes +--------------- + +### Write test report to file +godog is now able to write the report to a file. + +- `--format cucumber` will continue to write the report to `stdout` + +- `--format cucumber:report.json` will instead write the report to a file named `report.json` + +**Note**, godog still only support the use of one formatter. + +### Upload artifacts to the github release +The releases on github now include prebuilt binaries for: +- Linux for amd64 and arm64 +- macOs (Darwin) for amd64 + +### Restructure of the codebase with internal packages +A lot of the internal code that used to be in the main godog package has been moved to internal packages. + +The reason for this is mainly for decoupling to allow for simpler tests and to make the codebase easier to work with in general. + +Non Backward Compatible Changes +------------------------------- + +### Concurrency Formatter +`ConcurrencyFormatter` is now removed since the deprecation in [v0.10.0](./v0.10.0.md). + +### Run and RunWithOptions +`Run` and `RunWithOptions` are now removed since the deprecation in [v0.10.0](./v0.10.0.md). + +### Suite and SuiteContext +`Suite` and `SuiteContext` are now removed since the deprecation in [v0.10.0](./v0.10.0.md). + +Deprecation Notices +------------------- + +### BindFlags +`BindFlags(prefix, flag.CommandLine, &opts)` has been replaced by `BindCommandLineFlags(prefix, &opts)` and will be removed in `v0.12.0`. + +### Executing godog +godog has received sub-commands: (build, help, run, version) + +To run tests with godog, `godog []` has been replaced with `godog run []`. + +To build a test binary, `godog --output g.test []`has been replaced with `godog build --output g.test []`. + +Full change log +--------------- + +See [CHANGELOG.md](https://github.com/cucumber/godog/blob/master/CHANGELOG.md#v0110-rc1). \ No newline at end of file