update default docs and release process, drop bumpversion for

bump-my-version

Author: pacrob

.bumpversion.cfg

@@ -1,4 +1,4 @@
-exclude: '.project-template|docs/conf.py|.bumpversion.cfg'
+exclude: '.project-template|docs/conf.py'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0

.pre-commit-config.yaml

@@ -5,15 +5,15 @@ CURRENT_SIGN_SETTING := $(shell git config commit.gpgSign)
 help:
 	@echo "clean-build - remove build artifacts"
 	@echo "clean-pyc - remove Python file artifacts"
+	@echo "clean - run clean-build and clean-pyc"
+	@echo "dist - build package and cat contents of the dist directory"
 	@echo "lint - fix linting issues with pre-commit"
 	@echo "test - run tests quickly with the default Python"
 	@echo "docs - generate docs and open in browser (linux-docs for version on linux)"
 	@echo "autobuild-docs - live update docs when changes are saved"
-	@echo "notes - consume towncrier newsfragments/ and update release notes in docs/"
-	@echo "release - package and upload a release (does not run notes target)"
-	@echo "dist - package"
-
-clean: clean-build clean-pyc
+	@echo "package-test - build package and install it in a venv for manual testing"
+	@echo "notes - consume towncrier newsfragments and update release notes in docs - requires bump to be set"
+	@echo "release - package and upload a release (does not run notes target) - requires bump to be set"
 
 clean-build:
 	rm -fr build/
@@ -26,6 +26,12 @@ clean-pyc:
 	find . -name '*~' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -rf {} +
 
+clean: clean-build clean-pyc
+
+dist: clean
+	python -m build
+	ls -l dist
+
 lint:
 	@pre-commit run --all-files --show-diff-on-failure || ( \
 		echo "\n\n\n * pre-commit should have fixed the errors above. Running again to make sure everything is good..." \
@@ -35,62 +41,78 @@ lint:
 test:
 	python -m pytest tests
 
+# docs commands
+
+docs: check-docs
+	open docs/_build/html/index.html
+
+linux-docs: check-docs
+	xdg-open docs/_build/html/index.html
+
 autobuild-docs:
 	sphinx-autobuild --open-browser docs docs/_build/html
 
-build-docs:
-	sphinx-apidoc -o docs/ . setup.py "*conftest*"
-	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
-	$(MAKE) -C docs doctest
-	
-build-docs-ci:
-	$(MAKE) -C docs latexpdf
-	$(MAKE) -C docs epub
+# docs helpers
 
 validate-newsfragments:
 	python ./newsfragments/validate_files.py
 	towncrier build --draft --version preview
 
 check-docs: build-docs validate-newsfragments
 
+build-docs:
+	sphinx-apidoc -o docs/ . setup.py "*conftest*"
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(MAKE) -C docs doctest
+
 check-docs-ci: build-docs build-docs-ci validate-newsfragments
 
-docs: check-docs
-	open docs/_build/html/index.html
+build-docs-ci:
+	$(MAKE) -C docs latexpdf
+	$(MAKE) -C docs epub
 
-linux-docs: check-docs
-	xdg-open docs/_build/html/index.html
+# release commands
 
-check-bump:
-ifndef bump
-	$(error bump must be set, typically: major, minor, patch, or devnum)
-endif
+package-test: clean
+	python -m build
+	python scripts/release/test_package.py
 
-notes: check-bump validate-newsfragments
+notes: check-bump
 	# Let UPCOMING_VERSION be the version that is used for the current bump
-	$(eval UPCOMING_VERSION=$(shell bumpversion $(bump) --dry-run --list | grep new_version= | sed 's/new_version=//g'))
+	$(eval UPCOMING_VERSION=$(shell bump-my-version show --increment $(bump) new_version))
 	# Now generate the release notes to have them included in the release commit
 	towncrier build --yes --version $(UPCOMING_VERSION)
 	# Before we bump the version, make sure that the towncrier-generated docs will build
 	make build-docs
 	git commit -m "Compile release notes for v$(UPCOMING_VERSION)"
 
-release: check-bump clean
-	# require that upstream is configured for ethereum/<REPO_NAME>
-	@git remote -v | grep "upstream[[:space:]][email protected]:ethereum/<REPO_NAME>.git (push)\|upstream[[:space:]]https://github.com/ethereum/<REPO_NAME> (push)"
-	# verify that docs build correctly
+release: check-bump check-git clean
+	# verify that notes command ran correctly
 	./newsfragments/validate_files.py is-empty
-	make build-docs
 	CURRENT_SIGN_SETTING=$(git config commit.gpgSign)
 	git config commit.gpgSign true
-	bumpversion $(bump)
-	git push upstream && git push upstream --tags
+	bump-my-version bump $(bump)
 	python -m build
-	twine upload dist/*
 	git config commit.gpgSign "$(CURRENT_SIGN_SETTING)"
+	git push upstream && git push upstream --tags
+	twine upload dist/*
 
+# release helpers
 
-dist: clean
-	python -m build
-	ls -l dist
+check-bump:
+ifndef bump
+	$(error bump must be set, typically: major, minor, patch, or devnum)
+endif
+
+check-git:
+	# require that you be on a branch that's linked to upstream/main
+	@if ! git status -s -b | head -1 | grep -q "\.\.upstream/main"; then \
+		echo "Error: You must be on a branch that's linked to upstream/main"; \
+		exit 1; \
+	fi
+	# require that upstream is configured for ethereum/<REPO_NAME>
+	@if ! git remote -v | grep "upstream[[:space:]][email protected]:ethereum/<REPO_NAME>.git (push)\|upstream[[:space:]]https://github.com/ethereum/<REPO_NAME> (push)"; then \
+		echo "Error: You must have a remote named 'upstream' that points to '<REPO_NAME>'"; \
+		exit 1; \
+	fi

Makefile

@@ -8,61 +8,12 @@
 
 <SHORT_DESCRIPTION>
 
-Read more in the [documentation on ReadTheDocs](https://<RTD_NAME>.readthedocs.io/). [View the change log](https://<RTD_NAME>.readthedocs.io/en/latest/release_notes.html).
+Read the [documentation](https://<RTD_NAME>.readthedocs.io/).
 
-## Quickstart
+View the [change log](https://<RTD_NAME>.readthedocs.io/en/latest/release_notes.html).
 
-```sh
-python -m pip install <PYPI_NAME>
-```
-
-## Developer Setup
-
-If you would like to hack on <REPO_NAME>, please check out the [Snake Charmers
-Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
-for information on how we do:
-
-- Testing
-- Pull Requests
-- Documentation
-
-We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once
-installed, it will run automatically with every commit. You can also run it manually
-with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you
-can do so with `git commit --no-verify`.
-
-### Development Environment Setup
-
-You can set up your dev environment with:
-
-```sh
-git clone [email protected]:ethereum/<REPO_NAME>.git
-cd <REPO_NAME>
-virtualenv -p python3 venv
-. venv/bin/activate
-python -m pip install -e ".[dev]"
-pre-commit install
-```
-
-### Release setup
-
-To release a new version:
+## Installation
 
 ```sh
-make release bump=$$VERSION_PART_TO_BUMP$$
+python -m pip install <PYPI_NAME>
 ```
-
-#### How to bumpversion
-
-The version format for this repo is `{major}.{minor}.{patch}` for stable, and
-`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).
-
-To issue the next version in line, specify which part to bump,
-like `make release bump=minor` or `make release bump=devnum`. This is typically done from the
-main branch, except when releasing a beta (in which case the beta is released from main,
-and the previous stable branch is released from said branch).
-
-If you are in a beta version, `make release bump=stage` will switch to a stable.
-
-To issue an unstable version when the current version is stable, specify the
-new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`

README.md

@@ -0,0 +1,12 @@
+Usage
+-----
+
+Example usage:
+
+<MODULE_NAME>
+-------------
+
+.. automodule:: <MODULE_NAME>
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/MODULE_NAME.rst

@@ -0,0 +1,78 @@
+Code of Conduct
+---------------
+
+Our Pledge
+~~~~~~~~~~
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+Our Standards
+~~~~~~~~~~~~~
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+Our Responsibilities
+~~~~~~~~~~~~~~~~~~~~
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Scope
+~~~~~
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+Enforcement
+~~~~~~~~~~~
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+Attribution
+~~~~~~~~~~~
+
+This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html