gitで記事書いてますか?
안녕하신게라!パナソニックコネクト株式会社クラウドソリューション部オペレーション課の加賀です。みなさん、Qiitaで記事を元気に書いてますかーっ!?
QiitaCLIを用いて組織で記事を管理する際に注意したい3点!共有します!
まずは公式手順
QiitaCLIを導入することで、github Actionsと連携する環境を一発で構築できます。便利!
削除機能は無いため、公開した記事はpublic
フォルダから除外しても記事は消えません。
追記:除外後、勝手にID名のファイルが生成されてしまいます。しない方が良いかも。
記事のヘッダに要注意
githubから引用、説明が日本語で助かる。
---
title: newArticle001 # 記事のタイトル
tags:
- '' # タグ(ブロックスタイルで複数タグを追加できます)
private: false # true: 限定共有記事 / false: 公開記事
updated_at: "" # 記事を投稿した際に自動的に記事の更新日時に変わります
id: null # 記事を投稿した際に自動的に記事のUUIDに変わります
organization_url_name: null # 関連付けるOrganizationのURL名
slide: false # true: スライドモードON / false: スライドモードOFF
ignorePublish: false # true: `publish`コマンドにおいて無視されます(Qiitaに投稿されません) / false: `publish`コマンドで処理されます(Qiitaに投稿されます)
---
# new article body
注意点1
organization_url_name: null # 関連付けるOrganizationのURL名
この部分、何を指定したら良いのやら、検索しても地味にHITしないのです。なぜに。
https://qiita.com/organizations/{$.ここを指定する}
が正解なので、私達が記事を書く時は、
organization_url_name: panasonic-connect
と指定するべし。
注意点2
組織で限定共有記事を作成する事は出来ません(!)
organization_url_name: panasonic-connect
private: true # true: 限定共有記事 / false: 公開記事
としてしまうと、こんなエラーが出ます。
git_qiita_cli_org: 限定共有記事にOrganizationを紐付けることはできません
Error: Process completed with exit code 1.
よって、組織で公開記事をアップする際はfalse
で良いのですが、下書きや内部レビュー等をしたい場合に限定共有記事としたい場合は、organization_url_name
はnull
としておかねばなりません。
公開する時に改めて入れるように癖付けすれば良いのですけども、地味な注意点です。
これは仕様上どうにもならなかったのか。PR出せ?Qiita本体のソースどこさね?
注意点3
github Actionsを利用している場合限定の注意点です。push後は必ずfetchしましょう。
ActionsでQiitaCLIが動作する事で、各記事のヘッダが変更され、commitが入ります。
忘れるとstashしてpullしてmergeしてと記事作成以外の余計な手間が発生してしまいます。
vscode上でpushの一定時間後に自動的にpullする方法をご存じの方が居たら、コメントとかくれると泣いて喜びます。
まとめ
QiitaCLIを作ってくれてありがとう。
この記事が、誰かが楽に楽しくQiita記事を書くことの一助となりますように。
お断り
記事内容は個人の見解であり、所属組織の立場や戦略・意見を代表するものではありません。
あくまでエンジニアとしての経験や考えを発信していますので、ご了承ください。