Simple library to make it easier to manage the death of your application.
Use gopkg.in to import death based on your logger.
| Version | Go Get URL | source | doc | Notes |
|---|---|---|---|---|
| 3.x | github.com/vrecan/death/v3 | source | doc | This removes the need for an independent logger. By default death will not log but will return an error if all the closers do not properly close. If you want to provide a logger just satisfy the deathlog.Logger interface. This also uses go modules so import it as github.com/vrecan/death/v3 |
| 2.x | gopkg.in/vrecan/death.v2 | source | doc | This supports loggers who do not return an error from their Error and Warn functions like logrus |
| 1.x | gopkg.in/vrecan/death.v1 | souce | doc | This supports loggers who do return an error from their Error and Warn functions like seelog |
Example
go get gopkg.in/vrecan/death.v3package main
import (
DEATH "github.com/vrecan/death/v3"
SYS "syscall"
)
func main() {
death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
//when you want to block for shutdown signals
death.WaitForDeath() // this will finish when a signal of your type is sent to your application
}One simple feature of death is that it can also close other objects when shutdown starts
package main
import (
"log"
DEATH "github.com/vrecan/death/v3"
SYS "syscall"
"io"
)
func main() {
death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
objects := make([]io.Closer, 0)
objects = append(objects, &NewType{}) // this will work as long as the type implements a Close method
//when you want to block for shutdown signals
err := death.WaitForDeath(objects...) // this will finish when a signal of your type is sent to your application
if err != nil {
log.Println(err)
os.Exit(1)
}
}
type NewType struct {
}
func (c *NewType) Close() error {
return nil
}package main
import (
DEATH "github.com/vrecan/death/v3"
SYS "syscall"
)
func main() {
death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
//when you want to block for shutdown signals
death.WaitForDeathWithFunc(func(){
//do whatever you want on death
})
}- If you are releasing a new major version you need to branch off of master into a branch
release-branch.v#(examplerelease-branch.v2for a 2.x release) - If you are releasing a minor or patch update to an existing major release make sure to merge master into the release branch
When you are ready to publish the release make sure you...
- Merge your changes into the correct release branch.
- Check out the release branch locally (example:
git pull origin release-branch.v3) - Create a new tag for the specific release version you will publish (example:
git tag v3.0.1) - Push the tag up to github (example:
git push origin v3.0.1) - Go to the release tab in github
- Select the target branch as the release branch and type in the tag name (tagname should include
vso example:v3.0.1) - Write a title and a well worded description on exactly what is in this change
- Click publish release