incoming webhooksを使ったslack送信ライブラリをcomposerで公開した話
はじめに
お久しぶりです.
この前発売したポケモンダンジョンをやりながらどうぶつの森を待ち続けているなゆたです.
最近incoming webhooksを使ってslackに送信する処理を書いていて,これライブラリにした方が簡単だなって気づいてライブラリにして公開しました.
ライブラリについて
nayuta1999/sendslackerという名前でライブラリを公開しました.
installは
$ composer require nayuta1999/sendslacker
で行うことができます.
ライブラリはGuzzleを使ってAPIにアクセスします.
textのみを送りたい場合はclassのインスタンスを作成した後,sendText($text)を呼びます.
$textの中には送信したいテキストを入力します.
BlockやAttachementsは連想配列を作ってaddBlock()やaddAttachements()を呼びます.
BlockやAttachementsを使ったテキストを送りたい場合はsendContens()を呼んでください.
composerへの公開手順
簡単に書くと
こんな感じの流れです.
composer.jsonを書く
$composer init
を実行すると色々聞かれるのでそれに応えていくとcomposer.jsonが自動生成されます.
packagistに登録する.
このサイトからsign inします.githubのアカウント使うと楽ですね.
そのあとsubmitのところからリポジトリのURLを登録します.簡単ですね.
意識したポイント
- ライセンス
せっかくライブラリを作ったので使ってもらいたかったのでライセンスを設定しないのではなくMITライセンスを使いました.
他にも色々ライセンスがありましたが,GuzzleがMITライセンスを使ってたのでMITライセンスを使いました..
- READMEをちゃんと書く
他人に使ってもらえるライブラリを目指したので他の人のライブラリを見ながら使い方やinstall方法などを書きました.
もっとここを書くと良いなどを教えてもらえると嬉しです.
まとめ
今まであまり自分が作ったものを公開してこなかったので少し怖いですが少しずつ自分の進捗をこのように公開していきたいと思っています.
指摘・改善等ありましたらプルリクエストお待ちしていますのでお願いします.