skim0119 · December 29, 2021 04:34 · Dec 29, 2021 · Dec 11, 2021 · Dec 11, 2021 · Sep 18, 2015
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,37 +1,53 @@
-- [ ] Update HISTORY.md
+## Release Checklist
+
+- [ ] Update RELEASE.md - It should be in based on milestone description.
 - [ ] Commit the changes: 
+```bash
+git add RELEASE.md
+git commit -m "Changelog for upcoming release <version>"
 ```
-git add HISTORY.md
-git commit -m "Changelog for upcoming release 0.1.1."
-```
+- [ ] Final check `README` and `CONTRIBUTING`.
+
+### Setup.py
 - [ ] Update version number (can also be minor or major)
+  - [ ] Check if we need to upgrade `REQUIRES_PYTHON` or `REQUIRED` dependencies.
+- [ ] Update `download_url` in setup
+- [ ] Check if local installation can be done.
+
+### Test
+- [ ] Run the tests
+- [ ] Run the formatting
+- [ ] CI Check
 ```
-bumpversion patch
-```
-- [ ] Install the package again for local development, but with the new version number:
-```
-python setup.py develop
-```
-- [ ] Run the tests:
+python -m pytest
+make all
 ```
-tox
+
+### Documentation and Website
+- [ ] Update version label on documentation
+  - [ ] docs/conf.py
+  - [ ] docs/documentation.rst
+- [ ] Update Sphinx
+- [ ] Update version label on website
+
+```diff
+- BEYOND THIS, EACH STEP SHOULD BE DONE IN SERIAL (STEP_BY_STEPS). -
 ```
-- [ ] Submit a pull request with the history and version number changes. Have it reviewed and merged.
-- [ ] Release on PyPI by uploading both sdist and wheel:
+
+### Last Edit
+- [ ] Rebase the commit history (should be done by only one person) right before the PR.
+
+### Update
+1. [ ] Submit a pull request to private. Have it reviewed and merge.
+2. [ ] Push the merged branch (master/main) into the public repo.
+3. [ ] Mark the tag in a public repo. `git push --tags`
+4. [ ] Release on PyPI by uploading both sdist and wheel:
 ```
 python setup.py sdist upload
 python setup.py bdist_wheel upload
 ```
 
-- [ ] Test that it pip installs:
-```
-mktmpenv
-pip install my_project
-<try out my_project>
-deactivate
-```
-
-- [ ] Push: `git push`
-- [ ] Push tags: `git push --tags`
-- [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
-- [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
+### Final Check
+- [ ] Test that it pip installs
+- [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly.
+- [ ] Edit the release-page on GitHub. Paste the release notes with a title for the release.
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -16,6 +16,7 @@ python setup.py develop
 ```
 tox
 ```
+- [ ] Submit a pull request with the history and version number changes. Have it reviewed and merged.
 - [ ] Release on PyPI by uploading both sdist and wheel:
 ```
 python setup.py sdist upload

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,7 +1,7 @@
-- [ ] Update HISTORY.rst
+- [ ] Update HISTORY.md
 - [ ] Commit the changes: 
 ```
-git add HISTORY.rst
+git add HISTORY.md
 git commit -m "Changelog for upcoming release 0.1.1."
 ```
 - [ ] Update version number (can also be minor or major)

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,60 +1,36 @@
-- [x] Update HISTORY.rst
-- [x] Update version number in `my_project/__init__.py`
-- [x] Update version number in `setup.py`
-- [x] Install the package again for local development, but with the new version number:
+- [ ] Update HISTORY.rst
+- [ ] Commit the changes: 
 ```
-python setup.py develop
+git add HISTORY.rst
+git commit -m "Changelog for upcoming release 0.1.1."
 ```
-- [x] Run the tests:
+- [ ] Update version number (can also be minor or major)
 ```
-python setup.py test
-tox
+bumpversion patch
 ```
-
-- [x] Commit the changes: 
+- [ ] Install the package again for local development, but with the new version number:
 ```
-git add .
-git commit -m "Release 0.1.1"
-```
-
-- [x] Build the source distribution:
-```
-python setup.py sdist
+python setup.py develop
 ```
-
-- [x] Test that the sdist installs:
+- [ ] Run the tests:
 ```
-mktmpenv
-cd dist
-tar xzvf my_project-0.1.1.tar.gz
-cd my_project-0.1.1/
-python setup.py install
-<try out my_project>
-deactivate
+tox
 ```
-
-- [x] Release on PyPI by uploading both sdist and wheel:
+- [ ] Release on PyPI by uploading both sdist and wheel:
 ```
 python setup.py sdist upload
 python setup.py bdist_wheel upload
 ```
 
-- [x] Test that it pip installs:
+- [ ] Test that it pip installs:
 ```
 mktmpenv
 pip install my_project
 <try out my_project>
 deactivate
 ```
 
-- [x] Tag the last git commit with the version number:
-```
-git tag -a 0.1.1
-```
-
-  Put the same message as in HISTORY.rst.
-- [x] Push: `git push`
-- [x] Push tags: `git push --tags`
-- [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
+- [ ] Push: `git push`
+- [ ] Push tags: `git push --tags`
+- [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
-
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -55,6 +55,6 @@ git tag -a 0.1.1
   Put the same message as in HISTORY.rst.
 - [x] Push: `git push`
 - [x] Push tags: `git push --tags`
-- [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
+- [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
 
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -54,7 +54,7 @@ git tag -a 0.1.1
 
   Put the same message as in HISTORY.rst.
 - [x] Push: `git push`
-- [ ] Push tags: `git push --tags`
+- [x] Push tags: `git push --tags`
 - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
 
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -53,7 +53,7 @@ git tag -a 0.1.1
 ```
 
   Put the same message as in HISTORY.rst.
-- [ ] Push: `git push`
+- [x] Push: `git push`
 - [ ] Push tags: `git push --tags`
 - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -47,7 +47,7 @@ pip install my_project
 deactivate
 ```
 
-- [ ] Tag the last git commit with the version number:
+- [x] Tag the last git commit with the version number:
 ```
 git tag -a 0.1.1
 ```

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -39,7 +39,7 @@ python setup.py sdist upload
 python setup.py bdist_wheel upload
 ```
 
-- [ ] Test that it pip installs:
+- [x] Test that it pip installs:
 ```
 mktmpenv
 pip install my_project

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -33,7 +33,7 @@ python setup.py install
 deactivate
 ```
 
-- [ ] Release on PyPI by uploading both sdist and wheel:
+- [x] Release on PyPI by uploading both sdist and wheel:
 ```
 python setup.py sdist upload
 python setup.py bdist_wheel upload

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -22,7 +22,7 @@ git commit -m "Release 0.1.1"
 python setup.py sdist
 ```
 
-- [ ] Test that the sdist installs:
+- [x] Test that the sdist installs:
 ```
 mktmpenv
 cd dist

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -17,7 +17,7 @@ git add .
 git commit -m "Release 0.1.1"
 ```
 
-- [ ] Build the source distribution:
+- [x] Build the source distribution:
 ```
 python setup.py sdist
 ```

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -11,7 +11,7 @@ python setup.py test
 tox
 ```
 
-- [ ] Commit the changes: 
+- [x] Commit the changes: 
 ```
 git add .
 git commit -m "Release 0.1.1"

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -5,7 +5,7 @@
 ```
 python setup.py develop
 ```
-- [ ] Run the tests:
+- [x] Run the tests:
 ```
 python setup.py test
 tox

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,7 +1,7 @@
 - [x] Update HISTORY.rst
 - [x] Update version number in `my_project/__init__.py`
 - [x] Update version number in `setup.py`
-- [ ] Install the package again for local development, but with the new version number:
+- [x] Install the package again for local development, but with the new version number:
 ```
 python setup.py develop
 ```

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,6 +1,6 @@
 - [x] Update HISTORY.rst
 - [x] Update version number in `my_project/__init__.py`
-- [ ] Update version number in `setup.py`
+- [x] Update version number in `setup.py`
 - [ ] Install the package again for local development, but with the new version number:
 ```
 python setup.py develop

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,5 +1,5 @@
 - [x] Update HISTORY.rst
-- [ ] Update version number in `my_project/__init__.py`
+- [x] Update version number in `my_project/__init__.py`
 - [ ] Update version number in `setup.py`
 - [ ] Install the package again for local development, but with the new version number:
 ```

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,4 +1,4 @@
-- [ ] Update HISTORY.rst
+- [x] Update HISTORY.rst
 - [ ] Update version number in `my_project/__init__.py`
 - [ ] Update version number in `setup.py`
 - [ ] Install the package again for local development, but with the new version number:

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -56,5 +56,5 @@ git tag -a 0.1.1
 - [ ] Push: `git push`
 - [ ] Push tags: `git push --tags`
 - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
-- [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
+- [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
 
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -55,6 +55,6 @@ git tag -a 0.1.1
   Put the same message as in HISTORY.rst.
 - [ ] Push: `git push`
 - [ ] Push tags: `git push --tags`
-- [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
+- [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
 
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -54,7 +54,7 @@ git tag -a 0.1.1
 
   Put the same message as in HISTORY.rst.
 - [ ] Push: `git push`
-- [x] Push tags: `git push --tags`
+- [ ] Push tags: `git push --tags`
 - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
 
diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -53,7 +53,7 @@ git tag -a 0.1.1
 ```
 
   Put the same message as in HISTORY.rst.
-- [x] Push: `git push`
+- [ ] Push: `git push`
 - [x] Push tags: `git push --tags`
 - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
 - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -47,7 +47,7 @@ pip install my_project
 deactivate
 ```
 
-- [x] Tag the last git commit with the version number:
+- [ ] Tag the last git commit with the version number:
 ```
 git tag -a 0.1.1
 ```

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -39,7 +39,7 @@ python setup.py sdist upload
 python setup.py bdist_wheel upload
 ```
 
-- [x] Test that it pip installs:
+- [ ] Test that it pip installs:
 ```
 mktmpenv
 pip install my_project

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -33,7 +33,7 @@ python setup.py install
 deactivate
 ```
 
-- [x] Release on PyPI by uploading both sdist and wheel:
+- [ ] Release on PyPI by uploading both sdist and wheel:
 ```
 python setup.py sdist upload
 python setup.py bdist_wheel upload

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -22,7 +22,7 @@ git commit -m "Release 0.1.1"
 python setup.py sdist
 ```
 
-- [x] Test that the sdist installs:
+- [ ] Test that the sdist installs:
 ```
 mktmpenv
 cd dist

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -17,7 +17,7 @@ git add .
 git commit -m "Release 0.1.1"
 ```
 
-- [x] Build the source distribution:
+- [ ] Build the source distribution:
 ```
 python setup.py sdist
 ```

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -11,7 +11,7 @@ python setup.py test
 tox
 ```
 
-- [x] Commit the changes: 
+- [ ] Commit the changes: 
 ```
 git add .
 git commit -m "Release 0.1.1"

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -5,7 +5,7 @@
 ```
 python setup.py develop
 ```
-- [x] Run the tests:
+- [ ] Run the tests:
 ```
 python setup.py test
 tox

diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md
@@ -1,7 +1,7 @@
 - [ ] Update HISTORY.rst
 - [ ] Update version number in `my_project/__init__.py`
 - [ ] Update version number in `setup.py`
-- [x] Install the package again for local development, but with the new version number:
+- [ ] Install the package again for local development, but with the new version number:
 ```
 python setup.py develop
 ```
No results found