https://github.com/future-architect/backlogslackify
https://github.com/future-architect/backlogslackify
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/future-architect/backlogslackify
- Owner: future-architect
- License: apache-2.0
- Created: 2021-04-15T05:47:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-25T09:57:22.000Z (over 4 years ago)
- Last Synced: 2025-05-07T21:09:09.146Z (8 months ago)
- Language: Go
- Size: 58.6 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
backlogslackify
===============
[][license]
[license]: https://github.com/future-architect/backlogslackify/blob/master/LICENSE
**backlogslacify** creates a slack post to announce backlog tickets that match your search criteria(e.g. expired ticket).
it is depends on [github.com/kenzo0107/backlog](https://github.com/kenzo0107/backlog) to use Backlog API.
## Usage
* please set up the client and call Post()
```main.go
package main
import (
bls "github.com/maito1201/backlogslackify"
"os"
"time"
"github.com/kenzo0107/backlog"
)
func main() {
condition := []bls.SearchCondition{
{
Name: "Tickets Untreated",
Condition: &backlog.GetIssuesOptions{
ProjectIDs: []int{12345},
CategoryIDs: []int{12345, 23456},
StatusIDs: []int{1},
},
},
{
Name: "Tickets Doing",
Condition: &backlog.GetIssuesOptions{
ProjectIDs: []int{12345},
CategoryIDs: []int{12345, 23456},
StatusIDs: []int{2},
},
},
{
Name: "Tickets Done(Not Completed)",
Condition: &backlog.GetIssuesOptions{
ProjectIDs: []int{12345},
CategoryIDs: []int{12345, 23456},
StatusIDs: []int{3},
},
},
{
Name: "Tickets Must Complete Today!",
Condition: &backlog.GetIssuesOptions{
ProjectIDs: []int{12345},
CategoryIDs: []int{12345, 23456},
StatusIDs: []int{1, 2, 3},
DueDateUntil: "2021-04-01",
},
},
}
opts := bls.ClientOption {
BacklogApiKey: "dummy",
BacklogBaseUrl: "https://example.backlog.com",
BacklogDueDate: "weekend",
SlackWebhookUrl: "https://hooks.slack.com/services/EXAMPLE/EXAMPLE/EXAMPLE",
SlackChannel: "my-team-backlog",
SlackAccountName: "Backlog-bot",
SlackIconEmoji: ":backlog:",
SlackIconUrl: "",
IsSinglePost: true,
DryRun: false,
SearchConditions: condition,
}
if err := bls.Post(opts, time.Now()); err != nil {
log.Fatal(err)
}
}
```
* To keep your API keys safe, We recommend using json or something avoiding hard-code.
main.go
```main.go
package main
import (
bls "github.com/maito1201/backlogslackify"
"encoding/json"
"os"
"log"
"time"
)
func main() {
config, err := os.ReadFile("./config.json")
if err != nil {
log.Fatal(err)
}
var opts bls.ClientOption
if err := json.Unmarshal(config, &opts); err != nil {
log.Fatal(err)
}
if err := bls.Post(opts, time.Now()); err != nil {
log.Fatal(err)
}
}
```
config.json
```config.json
{
"backlog_api_key": "dummy",
"backlog_base_url": "https://exapmle.backlog.com",
"backlog_due_date": "end_of_month",
"slack_webhool_url": "https://hooks.slack.com/services/EXAMPLE/EXAMPLE/EXAMPLE",
"slack_channel": "my-team-backlog",
"slack_account_name": "",
"slack_icon_emoji": "",
"slack_icon_url": "https://example.com",
"is_single_post": false,
"dry_run": true,
"search_conditions": [
{
"name": "here is ticket info",
"condition": {
"ProjectIDs": [12345],
"CategoryIDs": [12345, 23456],
"StatusIDs": [1, 2, 3]
}
}
]
}
```
* If the DryRun option is true, the information will not be posted to slack, it will only be displayed to stdout.
## License
Apache2