Script Before release¶
Run this script before release (before deploying).
What this script does:
Undo all local changes in repository
Update version in __init__.py, README
Black files
Rename file “unreleased.rst” to version, add to index.rst
Commit “Version …”
Create tag
Add “unreleased.rst” to Change Log, add to index.rst
Commit
Git push
API - kivymd.tools.release.make_release
¶
-
kivymd.tools.release.make_release.
command
(cmd: list)¶
-
kivymd.tools.release.make_release.
get_previous_version
()¶ Returns latest tag in git.
-
kivymd.tools.release.make_release.
git_clean
()¶ Clean git repository from untracked and changed files.
-
kivymd.tools.release.make_release.
git_commit
(message: str, allow_error: bool = False)¶ Make commit.
-
kivymd.tools.release.make_release.
git_tag
(name: str)¶ Create tag.
-
kivymd.tools.release.make_release.
git_push
(branches_to_push: list)¶ Push all changes.
-
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)¶ Change version in kivymd/__init__.py.
-
kivymd.tools.release.make_release.
update_readme
(previous_version, version)¶ Change version in README.
-
kivymd.tools.release.make_release.
move_changelog
(index_file, unreleased_file, previous_version, version_file, version)¶
-
kivymd.tools.release.make_release.
create_unreleased_changelog
(index_file, unreleased_file, previous_version)¶
-
kivymd.tools.release.make_release.
main
()¶