diff --git a/README.md b/README.md index d321c6df..886d21bb 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,9 @@ The `master` branch always contains the latest tagged release. ```shell # Install the latest version on macOS. brew install noti + +# Install latest version, if you have Go installed. +go get github.com/variadico/noti/cmd/noti ``` If you don't want to build from source or install anything extra, just download @@ -61,31 +64,12 @@ Or download with your browser from the [latest release] page. If you want to build from source, then build like this. ```shell +# build binary make build -# or +# build binary and move to Go bin dir make install ``` -This project uses modules with vendoring. The Makefile sets `-mod=vendor` -automatically. Otherwise, you'll need to pass a flag or export a var if you -don't use the Makefile. - -```shell -go build -mod=vendor github.com/variadico/noti/cmd/noti -# or -export GOFLAGS="-mod=vendor" -export GO111MODULE="on" -go build github.com/variadico/noti/cmd/noti -``` - -Also, `go get` doesn't really work anymore starting in Go 1.12. - -If you have comments about these changes, please the leave the Go team an -experience report here. - -* https://github.com/golang/go/issues/27227 -* https://github.com/golang/go/issues/32502 - ## Examples Just put `noti` at the beginning or end of your regular commands. For more diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 7b878b2c..10e33a4b 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] - YYYY-MM-DD +## [3.5.0] - 2020-09-06 + +### Added + +* `--time` option to show execution time in message +* Twilio support + +### Fixed + +* Notification title in Telegram + ## [3.4.0] - 2019-12-07 ### Added @@ -235,7 +246,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. * OS X-specific flags and usage text from Linux and FreeBSD help. -[Unreleased]: https://github.com/variadico/noti/compare/3.4.0...dev +[Unreleased]: https://github.com/variadico/noti/compare/3.5.0...dev +[3.5.0]: https://github.com/variadico/noti/compare/3.4.0...3.5.0 [3.4.0]: https://github.com/variadico/noti/compare/3.3.0...3.4.0 [3.3.0]: https://github.com/variadico/noti/compare/3.2.0...3.3.0 [3.2.0]: https://github.com/variadico/noti/compare/3.1.0...3.2.0 diff --git a/docs/man/noti.1 b/docs/man/noti.1 index 6de61fd6..46685b65 100644 --- a/docs/man/noti.1 +++ b/docs/man/noti.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 2.7.3 +.\" Automatically generated by Pandoc 2.10.1 .\" -.TH "NOTI" "1" "2018/03/25" "noti 3.4.0" "Noti Manual" +.TH "NOTI" "1" "2018/03/25" "noti 3.5.0" "Noti Manual" .hy .SH NAME .PP @@ -15,77 +15,77 @@ Noti can alert you when it\[cq]s done. You can receive messages on your computer or phone. .SH OPTIONS .TP -.B -t , --title +-t , --title Set notification title. Default is utility name. .TP -.B -m , --message +-m , --message Set notification message. Default is \[lq]Done!\[rq]. Read from stdin with \[lq]-\[rq]. .TP -.B -b, --banner +-b, --banner Trigger a banner notification. This is enabled by default. To disable this service, set this flag to false. This will be either \f[C]nsuser\f[R], \f[C]freedesktop\f[R], or \f[C]notifyicon\f[R] notification, depending on the OS. .TP -.B -s, --speech +-s, --speech Trigger a speech notification. This will be either \f[C]say\f[R], \f[C]espeak\f[R], or \f[C]speechsynthesizer\f[R] notification, depending on the OS. .TP -.B -c, --bearychat +-c, --bearychat Trigger a BearyChat notification. This requires \f[C]bearychat.incomingHookURI\f[R] to be set. .TP -.B \[en]keybase +\[en]keybase Trigger a Keybase notification. This requires \f[C]keybase.conversation\f[R] to be set. .TP -.B -p, --pushbullet +-p, --pushbullet Trigger a Pushbullet notification. This requires \f[C]pushbullet.accessToken\f[R] to be set. .TP -.B -o, --pushover +-o, --pushover Trigger a Pushover notification. This requires \f[C]pushover.apiToken\f[R] and \f[C]pushover.userKey\f[R] to be set. .TP -.B -u, --pushsafer +-u, --pushsafer Trigger a Pushsafer notification. This requires \f[C]pushsafer.key\f[R] to be set. .TP -.B -l, --simplepush +-l, --simplepush Trigger a Simplepush notification. This requires \f[C]simplepush.key\f[R] to be set. .TP -.B -k, --slack +-k, --slack Trigger a Slack notification. This requires \f[C]slack.appurl\f[R] (for Slack apps) or \f[C]slack.token\f[R] and \f[C]slack.channel\f[R] (for legacy tokens) to be set. -.B --twilio +.TP +\[en]twilio Trigger a Twilio notification. -This requires \f[C]slack.appurl\f[R] (for Slack apps) or -\f[C]slack.token\f[R] and \f[C]slack.channel\f[R] (for legacy tokens) to -be set. +This requires \f[C]twilio.authToken\f[R], \f[C]twilio.accountSid\f[R], +\f[C]twilio.numberFrom\f[R] and \f[C]twilio.numberTo\f[R] to be set. .TP -.B -w , --pwatch +-w , --pwatch Monitor a process by PID and trigger a notification when the pid disappears. .TP -.B -f, --file +-f, --file Path to \f[C]noti.yaml\f[R] configuration file. .TP -.B --verbose +--verbose Enable verbose mode. .TP -.B -v, --version +-v, --version Print \f[C]noti\f[R] version and exit. .TP -.B -h, --help +-h, --help Print \f[C]noti\f[R] help and exit. .SH ENVIRONMENT .IP \[bu] 2 @@ -130,6 +130,14 @@ Print \f[C]noti\f[R] help and exit. \f[C]NOTI_SLACK_CHANNEL\f[R] .IP \[bu] 2 \f[C]NOTI_SLACK_USERNAME\f[R] +.IP \[bu] 2 +\f[C]NOTI_TWILIO_TO\f[R] +.IP \[bu] 2 +\f[C]NOTI_TWILIO_FROM\f[R] +.IP \[bu] 2 +\f[C]NOTI_TWILIO_ACCOUNTSID\f[R] +.IP \[bu] 2 +\f[C]NOTI_TWILIO_AUTHTOKEN\f[R] .SH FILES .PP If not explicitly set with --file, then noti will check the following diff --git a/docs/man/noti.1.md b/docs/man/noti.1.md index 6a1237a3..efebe5fd 100644 --- a/docs/man/noti.1.md +++ b/docs/man/noti.1.md @@ -1,4 +1,4 @@ -% NOTI(1) noti 3.4.0 | Noti Manual +% NOTI(1) noti 3.5.0 | Noti Manual % Jaime Piña % 2018/03/25 diff --git a/docs/man/noti.yaml.5 b/docs/man/noti.yaml.5 index b9c4e23f..a75b3d06 100644 --- a/docs/man/noti.yaml.5 +++ b/docs/man/noti.yaml.5 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.10.1 .\" -.TH "NOTI.YAML" "5" "2018/03/25" "noti 3.4.0" "Noti Configuration File Format" +.TH "NOTI.YAML" "5" "2018/03/25" "noti 3.5.0" "Noti Configuration File Format" .hy .SH NAME .PP @@ -119,6 +119,28 @@ Can be either a #channel or a \[at]username. .TP username Noti bot username. +.SH TWILIO +.TP +AuthToken +Twilio access token. +Log into your Twilio account and copy the AuthToken from your project +dashboard +.TP +accountSid +Twilio account id. +Log into your Twilio account and copy the accountSid from your project +dashboard. +.TP +numberTo +This parameter determines the destination phone number for your SMS +message. +Format this number with a `+' and a country code, e.g., +16175551212 +.TP +numberFrom +From specifies the Twilio phone number, short code, or Messaging Service +that sends this message. +This must be a Twilio phone number that you own, formatted with a `+' +and country code, e.g.\ +16175551212 (E.164 format) .SH EXAMPLES .IP .nf @@ -151,6 +173,11 @@ simplepush: event: 1234567890abcdefg slack: appurl: \[aq]https://hooks.slack.com/services/xxx/yyy/zzz\[aq] +twilio: + numberto: +972542877978 + numberfrom: +18111119711 + accountsid: AC3cd135aa82XXXXXXXXf792ba23fc98 + authtoken: 74efd0bXXXXXXXXXXX32f7daca \f[R] .fi .SH SEE ALSO diff --git a/docs/man/noti.yaml.5.md b/docs/man/noti.yaml.5.md index 3e314506..a02c8620 100644 --- a/docs/man/noti.yaml.5.md +++ b/docs/man/noti.yaml.5.md @@ -1,4 +1,4 @@ -% NOTI.YAML(5) noti 3.4.0 | Noti Configuration File Format +% NOTI.YAML(5) noti 3.5.0 | Noti Configuration File Format % Jaime Piña % 2018/03/25 diff --git a/docs/release.md b/docs/release.md index 4cdfb98d..e3597339 100644 --- a/docs/release.md +++ b/docs/release.md @@ -7,8 +7,7 @@ just writing this down for myself. Make sure latest dev is green on CI. -* https://circleci.com/gh/variadico/noti -* https://ci.appveyor.com/project/variadico/noti +https://github.com/variadico/noti/actions?query=workflow%3ATesting ## Increment version @@ -30,8 +29,7 @@ git push origin master Make sure latest master is green on CI. -* https://circleci.com/gh/variadico/noti -* https://ci.appveyor.com/project/variadico/noti +https://github.com/variadico/noti/actions?query=workflow%3ATesting ## Double check @@ -49,17 +47,12 @@ git push origin 1.2.3 ## Edit GitHub release information -* Click on Releases > 1.2.3 > Edit tag. -* Make the release title 1.2.3. -* Copy and paste the changes from CHANGELOG.md into the description box. - -Create release tarballs. - -``` -make release -``` - -Upload files. +* Hopefully, when you pushed, GitHub Actions automatically created a release + draft and uploaded tarballs +* Go to https://github.com/variadico/noti/actions?query=workflow%3ARelease and + delete `noti.darwinrelease`, it's temporary junk. It's fine. +* Add CHANGELOG notes to release body +* Publish release ## Eventually update Homebrew