Script to make release¶
Run this script before release (before deploying).
What this script does:
Undo all local changes in repository
Update version in __init__.py, README.md
Format files
Rename file “unreleased.rst” to version, add to index.rst
Commit “Version …”
Create tag
Add unreleased.rst to Changelog, add to index.rst
Commit
Git push
API - kivymd.tools.release.make_release
¶
- kivymd.tools.release.make_release.run_pre_commit()¶
Run pre-commit.
- kivymd.tools.release.make_release.replace_in_file(pattern, repl, file)¶
Replace one pattern match to repl in file file.
- kivymd.tools.release.make_release.update_init_py(version, is_release, test: bool = False)¶
Change version in kivymd/__init__.py.
- kivymd.tools.release.make_release.update_readme(previous_version, version, test: bool = False)¶
Change version in README.md.
- kivymd.tools.release.make_release.move_changelog(index_file, unreleased_file, previous_version, version_file, version, test: bool = False)¶
Edit unreleased.rst and rename to <version>.rst.
- kivymd.tools.release.make_release.create_unreleased_changelog(index_file, unreleased_file, version, ask: bool = True, test: bool = False)¶
Create unreleased.rst by template.
- kivymd.tools.release.make_release.main()¶
- kivymd.tools.release.make_release.create_argument_parser()¶