From 29c3fa126a4d395bcddfa89fd5eab70b16961afa Mon Sep 17 00:00:00 2001 From: Marc Coury Date: Tue, 28 Jan 2020 17:31:04 +0000 Subject: [PATCH] Make work with kaluza tech and changelog-tool (#1) --- CHANGELOG.md | 36 +++++++++++++++++++----------------- README.md | 26 ++++++++++++++++++++++++++ go.mod | 2 +- rununtil_test.go | 2 +- 4 files changed, 47 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b2b58aa..e04239d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,34 +1,36 @@ -# Changelog -All notable changes to this project will be documented in this file. +# Change Log -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] -[Unreleased]: https://github.com/mec07/rununtil/compare/v0.2.0...HEAD +## [0.2.1] - 2020-01-28 + +### Changed + +- Migrate to kaluza-tech ## [0.2.0] - 2019-06-12 -[0.2.0]: https://github.com/mec07/rununtil/compare/v0.1.0...v0.2.0 + +### Fixed + +- There was a problem with sending a kill signal to a nonblocking main function. This has been fixed by providing the CancelAll method. + ### Changed + - Deprecate: functions KillSignal, Signals, and Killed - Replace them with: AwaitKillSignal, AwaitKillSignals and CancelAll -### Fixed -- There was a problem with sending a kill signal to a nonblocking main function. - This has been fixed by providing the CancelAll method. - ## [0.1.0] - 2019-06-12 -[0.1.0]: https://github.com/mec07/rununtil/compare/v0.0.1...v0.1.0 -### Changed -- There are now RunnerFunc and ShutdownFunc function types to clarify the usage of this library (backwards incompatible change) ### Added + - Implemented the rununtil.Killed method, which allows you to test a function that uses rununtil.KillSignal +### Changed + +- There are now RunnerFunc and ShutdownFunc function types to clarify the usage of this library (backwards incompatible change) ## [0.0.1] - 2019-06-05 -[0.0.1]: https://github.com/mec07/rununtil/releases/tag/v0.0.1 -### Added -- initial commit of rununtil library +### Added +- initial commit of rununtil library diff --git a/README.md b/README.md index 7995838..14b1bc3 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,29 @@ Go library to run a function until a kill signal is recieved. See the docs: https://godoc.org/github.com/mec07/rununtil + +## Changelog + +The [CHANGELOG.md](./CHANGELOG.md) file tracks all of the changes and each release. +We are managing it using the helpful [changelog-tool](https://github.com/ponylang/changelog-tool). +On Mac you can install it with brew: `brew install kaluza-tech/devint/changelog-tool`. +On linux (or any other platform) you have to install the pony language. +Then just follow the instructions on the github page for installing the changelog-tool: +https://github.com/ponylang/changelog-tool#installation + +The use of the tool is straightforward. +To create a new changelog (don't run this in this repo because then you'll replace the current changelog with a new one!): +``` +changelog-tool new +``` +To start recording a new entry: +``` +changelog-tool unreleased -e +``` +The `-e` means update the changelog file in place. +Then manually edit the changelog to add your changes in the unreleased section. +When you're ready you can then "release" it by executing: +``` +changelog-tool release 0.0.1 -e +``` +Replace `0.0.1` with the new version. diff --git a/go.mod b/go.mod index 17d0985..3d4a8d7 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/mec07/rununtil +module github.com/kaluza-tech/rununtil go 1.12 diff --git a/rununtil_test.go b/rununtil_test.go index 602a5f5..3b414eb 100644 --- a/rununtil_test.go +++ b/rununtil_test.go @@ -6,7 +6,7 @@ import ( "testing" "time" - "github.com/mec07/rununtil" + "github.com/kaluza-tech/rununtil" ) func helperSendSignal(t *testing.T, p *os.Process, sent *bool, signal os.Signal, delay time.Duration) {