README
¶
Life 
Simple wrapper for handling creation and management of a single background goroutine.
Why?
In most of our go programs we had a lot of boilerplate code that if done wrong would generate bugs.
common mistakes this helps us avoid:
- sync.Waitgroup without a pointer
- done channel with a size above 0 //if 0 and close is called but start isn't you block forever
- start is always in a Once.Do so repeated calls to start don't spin up multiple goroutines
Release Process
Rules for release branches:
- 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
Rules for tagging and publishing the release
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
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Life ¶
type Life struct {
Done chan struct{}
// contains filtered or unexported fields
}
Life handles the creation of the background thread and shutdown management
Source Files
Click to show internal directories.
Click to hide internal directories.