Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

予約投稿に関する説明を README.md に追記してほしい #30

Open
pankona opened this issue Jan 18, 2024 · 4 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@pankona
Copy link

pankona commented Jan 18, 2024

プルリクエストによって作成したドラフト記事を予約投稿したいと思いました。プルリクエストによって作成したドラフト記事ははてなブックマーク側の編集ページを用いて予約投稿が可能であると思いますが、記事が公開されたあとのプルリクエストの沙汰が気になっています (マージするべきなのか、マージせずにクローズするべきなのか、等)。
予約投稿を行う際のオススメの手順が README に書かれていると便利そうと思いましたが、いかがでしょうか!

@airreader
Copy link
Contributor

ありがとうございます!なるほど。確かに予約投稿周りのリポジトリ側での操作とはてなブログ側での操作は自明ではないですね。
こちらReadmeへの追記を検討いたします!

@pankona
Copy link
Author

pankona commented Jan 19, 2024

@airreader
ありがとうございます!

@pankona
Copy link
Author

pankona commented Jan 19, 2024

この質問、お願いの背景をちょっと補足いたします。このような気持ちで issue を立てました。

  • 予約投稿によって記事を公開したあとにプルリクエストをマージしたとして、記事が二重に公開されてしまったりしないか、というのを心配しました
  • 一方、プルリクエストをマージせずにそのままクローズしたとして、公開されている記事とリポジトリの状況に差ができてしまう気がしていてそれも懸念でした
    • この場合は予約投稿が公開されたあと、ふたたびはてぶとリポジトリを同期すれば良い話ではあるかな、と思っています
    • が、これが推奨されるプロセスであるのか?というのは気になる点でした

このあたりはどのようにするのがオススメであるか、README に書かれていると嬉しいな、と思ったことが背景でした。

@airreader
Copy link
Contributor

airreader commented Jan 24, 2024

背景を詳しく教えていただきありがとうございます。
仕組み上は、記事ファイルに含まれている下記の記述がユニークなエントリのIDと対応していて、このエントリの操作を行います。
EditURL: https://blog.hatena.ne.jp/hatenablog/example.hatenablog.com/atom/entry/10000000000000000000
これは下書きを公開しても変化しませんので、予約記事公開後にプルリクエストをマージしても記事が二重に公開されることはありません。

一方、予約投稿でエントリが公開されたとしても、その情報はリポジトリ側には反映されませんので、リポジトリ側で何らか操作する必要があります。
が、現状の仕組み上、予約投稿(はてなブログ側で公開操作が行われたエントリ)の取り扱いを想定していないため、いくつかの操作が必要になります。
現状では「これがベスト」という方法を案内することが出来ませんが、予約投稿記事公開に関しては2通りの方法が考えられます。

前者はプルリクエストの履歴が残るメリットがありますが、リポジトリの同期の操作が複雑になります。
後者は編集履歴が残りませんが、同期の操作は簡潔になります。

どちらを選択するかはリポジトリの運用方針に従ってご検討ください。
また、READMEへの追記、仕組みでの解決も検討してまいります。

プルリクエストをマージする方法

  1. プルリクエストをmainリポジトリにマージする
  • この際、draft:true を削除してはいけません
  1. はてなブログ側で予約投稿を行う
  2. 記事が公開されたら pull form hatenablog アクションを実行する
  3. /draft_entries から予約投稿記事を削除する

プルリクエストをクローズする方法

  1. プルリクエストをクローズする
  2. はてなブログ側で予約投稿を行う
  3. 記事が公開されたら pull from hatenablog アクションを実行する

@susisu susisu added the documentation Improvements or additions to documentation label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants