bpmailerのPyPIへのリリース手順を記述するchecklistを追加 (#17)

* リリース手順を記述するようのchecklistを追加 * TestPyPIにアップロードする作業まで、たたき台の記述を追加 * checklistの記述を修正 * リリース手順の記述を加筆修正 * いくつか記述を省略。記述形式を変更。 * rstの記法を修正 * 記述を修正 * typo修正 * 一部文章表現を修正しました * suggestionを反映しました Co-authored-by: masashinji <[email protected]> * suggestionを反映しました(typo修正) Co-authored-by: masashinji <[email protected]> * GitHubの名称のtypo suggestionを取り込み。他の箇所も修正します。 Co-authored-by: Kashun YOSHIDA <[email protected]> * Githubの名称のtypoを修正 * PyPIアカウントに対して編集権限を付与してもらう旨を追記 * 文言の加筆修正。バージョン指定の記述を修正。 * ファイル名の変更 * READMEにリリース手順へのリンクを追加 * celeryバージョン指定のsuggestion反映。 * 簡潔に書くsuggestionを反映しました Co-authored-by: Takayuki SHIMIZUKAWA <[email protected]> * release checklistのリンク先を修正 * 全体的に記述を修正 * 記述を短くした * 文章のネスト構造を修正 * 保守対象の文章としては冗長と思われる内容を削除 * 「する」という記述を全体的に削除 * TestPyPIにアップロードしたパッケージのインストール確認は、リリース手順から外しました。 * 不自然に登場した名詞の表現を修正 * suggestionを反映 * 言葉足らず修正suggestionを反映 Co-authored-by: masashinji <[email protected]> Co-authored-by: masashinji <[email protected]> Co-authored-by: Kashun YOSHIDA <[email protected]> Co-authored-by: Takayuki SHIMIZUKAWA <[email protected]>
beproud · Mar 24, 2022 · 75b7db1 · 75b7db1
1 parent 8815017
commit 75b7db1
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -8,3 +8,8 @@ Requirements
 * Python (3.6, 3.9)
 * Celery (4.1)
 * Django (2.2)
+
+Links
+=================
+
+* `release checklist <https://github.com/beproud/bpmailer/blob/master/release_checklist.rst>`_
diff --git a/release_checklist.rst b/release_checklist.rst
@@ -0,0 +1,37 @@
+リリース手順
+==============
+
+事前準備
+--------------
+
+* GitHub, PyPI, TestPyPIのアカウントにbpmailerの編集権限を設定
+* パッケージのビルドに使用するパッケージをインストール
+
+  * ``pip install wheel twine``
+
+
+手順
+--------------------
+1. 次バージョンのパッケージをビルド
+
+   * ``python setup.py sdist bdist_wheel``
+
+2. twineのコマンドを実行して、エラーが出ないことを確認
+
+   * ``twine check --strict dist/*``
+
+3. dist/に作成したパッケージをTestPyPIへアップロード
+
+   * ``twine upload --repository testpypi dist/*``
+
+4. TestPyPIで、descriptionがエラーなく表示されていることと、ビルドしたパッケージがアップロードされていることを確認
+
+   * TestPyPIへアップロードした内容に問題がある場合、修正したパッケージをTestPyPIに再度アップロード
+
+5. GitHubで次バージョンのReleaseタグを作成し、Publish Releaseを実行
+
+   * dist/に試行錯誤したパッケージが残っている場合、一度全て削除し、本番アップロード用のパッケージを再度作成
+
+6. dist/に作成したパッケージを本番環境のPyPIにアップロード
+
+   * ``twine upload dist/*``