Merge pull request #9 from beproud/add-checklist

リリース手順書を追加。setup.pyの記述を追加。ドキュメントのtravis-ciのリンクをgithub actionsに変更。

README-ja.rst

@@ -61,7 +61,8 @@ https://bpmappers.readthedocs.io/ja/latest/
 開発
 ====
 
-このプロジェクトはGitHubでホストされています: https://github.com/beproud/bpmappers
+* このプロジェクトはGitHubでホストされています: https://github.com/beproud/bpmappers
+* リリース手順: https://github.com/beproud/bpmappers/blob/master/release_checklist.rst
 
 作者
 ====
@@ -73,8 +74,8 @@ https://bpmappers.readthedocs.io/ja/latest/
 
 - Shinya Okano <[email protected]>
 
-.. |build-status| image:: https://travis-ci.org/beproud/bpmappers.svg?branch=master
-   :target: https://travis-ci.org/beproud/bpmappers
+.. |build-status| image:: https://github.com/beproud/bpmappers/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/beproud/bpmappers/actions
 .. |docs| image:: https://readthedocs.org/projects/bpmappers/badge/?version=latest
    :target: https://bpmappers.readthedocs.io/ja/latest/
 .. |pypi| image:: https://badge.fury.io/py/bpmappers.svg

README.rst

@@ -61,7 +61,8 @@ https://bpmappers.readthedocs.io/ja/stable/
 Develop
 =======
 
-This project is hosted at Github: https://github.com/beproud/bpmappers
+- This project is hosted at GitHub: https://github.com/beproud/bpmappers
+- Release Procedure: https://github.com/beproud/bpmappers/blob/master/release_checklist.rst
 
 Author
 ======
@@ -73,8 +74,8 @@ Maintainer
 
 - Shinya Okano <[email protected]>
 
-.. |build-status| image:: https://travis-ci.org/beproud/bpmappers.svg?branch=master
-   :target: https://travis-ci.org/beproud/bpmappers
+.. |build-status| image:: https://github.com/beproud/bpmappers/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/beproud/bpmappers/actions
 .. |docs| image:: https://readthedocs.org/projects/bpmappers/badge/?version=stable
    :target: https://bpmappers.readthedocs.io/ja/stable/
 .. |pypi| image:: https://badge.fury.io/py/bpmappers.svg

bpmappers/__init__.py

@@ -13,4 +13,4 @@
     'DataError', 'InvalidDelegateException',
 ]
 
-VERSION = (1, 2, 0, None)
+VERSION = (1, 3, 0, None)

docs/ja/source/conf.py

@@ -49,17 +49,17 @@
 
 # General information about the project.
 project = 'bpmappers'
-copyright = '2020, BeProud,Inc'
+copyright = '2022, BeProud,Inc'
 author = 'BeProud,Inc'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.2'
+version = '1.3'
 # The full version, including alpha/beta/rc tags.
-release = '1.2'
+release = '1.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

release_checklist.rst

@@ -0,0 +1,37 @@
+リリース手順
+==============
+
+事前準備
+--------------
+
+* GitHub, PyPI, TestPyPIのアカウントにbpmappersの編集権限を設定
+* パッケージのビルドに使用するパッケージをインストール
+
+  * ``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/*``

setup.py

@@ -17,6 +17,7 @@ def read_file(filename):
     description='bpmappers is a Python moudle that maps Python dictionary '
     'values and object properties to different dictionary.',
     long_description=read_file('README.rst'),
+    long_description_content_type="text/x-rst",
     author='BeProud Inc.',
     author_email='[email protected]',
     url='https://bpmappers.readthedocs.io/ja/stable/',