Slide 1
Slide 1 text
Atomic Commits
An Easy & Proven Way to Manage & Automate Release Process
Slide 2
Slide 2 text
No content
Slide 3
Slide 3 text
No content
Slide 4
Slide 4 text
No content
Slide 5
Slide 5 text
No content
Slide 6
Slide 6 text
__name__ = 李唯 / Wei Lee
__what_i_am_doing__ = [
volunteers @ PyCon Taiwan,
maintainer of commitizen-tools,
]
__github__ =
G
Lee-W
__site__ =
p
http://wei-lee.me
$ cat speaker.py
Slide 7
Slide 7 text
File "speaker.py", line 1
__name__ = 李唯 / Wei Lee
^^^
SyntaxError: invalid syntax
$ python speaker.py
Slide 8
Slide 8 text
Release
Slide 9
Slide 9 text
Release
requests release history https://pypi.org/project/requests/#history
Slide 10
Slide 10 text
Software Versioning
x.y.z
Slide 11
Slide 11 text
Calendar Versioning
Slide 12
Slide 12 text
One of the schemes of
Calendar Versioning
x.y.z
Year Month Date
Slide 13
Slide 13 text
Example
Slide 14
Slide 14 text
Example
Slide 15
Slide 15 text
Example
Slide 16
Slide 16 text
And many other schemes
Slide 17
Slide 17 text
Semantic Versioning
Slide 18
Slide 18 text
Semantic Versioning
x.y.z
MAJOR Minor Patch
Slide 19
Slide 19 text
From @memenetes https://twitter.com/memenetes/status/1631339227785969664/photo/1
Example (meme)
Slide 20
Slide 20 text
https://hynek.me/articles/semver-will-not-save-you/
Slide 21
Slide 21 text
Even though it's not the savior,
many projects are using it.
Slide 22
Slide 22 text
Example
Slide 23
Slide 23 text
Release a new version
Slide 24
Slide 24 text
Example release processes
Slide 25
Slide 25 text
Example release processes
Slide 26
Slide 26 text
Example release processes
Slide 27
Slide 27 text
Semantic Versioning
1. MAJOR: incompatible change
2. MINOR: backward compatible functionalities
3. PATCH: backward compatible bug fixes
Slide 28
Slide 28 text
Commits from CPython
What will you do if these are the
changes you're going to release?
Slide 29
Slide 29 text
No content
Slide 30
Slide 30 text
When developers made these changes,
they knew what they were changing.
Slide 31
Slide 31 text
No content
Slide 32
Slide 32 text
Concise commit messages make
comprehending the changes easier
Slide 33
Slide 33 text
No content
Slide 34
Slide 34 text
No content
Slide 35
Slide 35 text
How to write good commit
messages?
1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
Slide 36
Slide 36 text
Semantic Versioning
1. MAJOR: incompatible change
2. MINOR: backward compatible functionalities
3. PATCH: backward compatible bug fixes
Slide 37
Slide 37 text
Semantic Versioning
1. MAJOR: incompatible change
2. MINOR: backward compatible functionalities
3. PATCH: backward compatible bug fixes
4. OTHER: other changes (e.g., documentation change)
Slide 38
Slide 38 text
Type of Changes
1.New Feature
2.Bug fix
3.Refactor
4.Style Change
5.Documentation
6.Improve test coverage
7.Performance
8.Build tool
9.CI/CD
10.and etc.
Slide 39
Slide 39 text
Mapping
Type of change → Version
Slide 40
Slide 40 text
Mapping
Type of change → Version
Slide 41
Slide 41 text
A simple rule example
(add the type at the end of commits)
Slide 42
Slide 42 text
A simple rule example
(add the type at the end of commits)
Slide 43
Slide 43 text
A simple rule example
(add the type at the end of commits)
Slide 44
Slide 44 text
Is there a better rule?
Slide 45
Slide 45 text
No content
Slide 46
Slide 46 text
No content
Slide 47
Slide 47 text
Conventional Commit Scheme
Somehow set language to "Turtle" for syntax highlight works well 🤔
Slide 48
Slide 48 text
Example
Commits from conventional-commit website
Slide 49
Slide 49 text
No content
Slide 50
Slide 50 text
No content
Slide 51
Slide 51 text
No content
Slide 52
Slide 52 text
No content
Slide 53
Slide 53 text
commitizen-tools
Slide 54
Slide 54 text
Please like
Slide 55
Slide 55 text
Please like, subscribe
Slide 56
Slide 56 text
Please like, subscribe and contribute
Slide 57
Slide 57 text
No content
Slide 58
Slide 58 text
Install commitizen
Slide 59
Slide 59 text
Initialize commitizen
Slide 60
Slide 60 text
Initialize commitizen
Slide 61
Slide 61 text
Initialize commitizen
Slide 62
Slide 62 text
Initialize commitizen
Slide 63
Slide 63 text
Initialize commitizen
Slide 64
Slide 64 text
Initialize commitizen
Slide 65
Slide 65 text
Initialize commitizen
Slide 66
Slide 66 text
Initialize commitizen
Slide 67
Slide 67 text
Initialize commitizen
Slide 68
Slide 68 text
Initialize commitizen
Slide 69
Slide 69 text
Making a commit
Slide 70
Slide 70 text
Making a commit
Slide 71
Slide 71 text
Making a commit
Slide 72
Slide 72 text
Making a commit
Slide 73
Slide 73 text
Making a commit
Slide 74
Slide 74 text
Making a commit
Slide 75
Slide 75 text
Making a commit
Slide 76
Slide 76 text
Output commit
Slide 77
Slide 77 text
Bump version
Slide 78
Slide 78 text
Bump version
Slide 79
Slide 79 text
Bump version
Generate a new commit for
bumping versions
Slide 80
Slide 80 text
Bump version
Slide 81
Slide 81 text
Changelog
Slide 82
Slide 82 text
No content
Slide 83
Slide 83 text
Customizable changelog WIP
Slide 84
Slide 84 text
Integrate with GitHub Actions
Slide 85
Slide 85 text
Integrate with GitHub Actions
Slide 86
Slide 86 text
Integrate with GitHub Actions
Slide 87
Slide 87 text
Integrate with GitHub Actions
Slide 88
Slide 88 text
Integrate with GitHub Actions
Slide 89
Slide 89 text
Let's wrap up the process
Slide 90
Slide 90 text
Commit flow
Slide 91
Slide 91 text
Release flow
Slide 92
Slide 92 text
Join us and
make commitizen-tools better ⭐
Slide 93
Slide 93 text
No content
Slide 94
Slide 94 text
PyCast EP 4
Slide 95
Slide 95 text
Pyducts Pre-Order
Slide 96
Slide 96 text
Pyducts Pre-Order
Slide 97
Slide 97 text
Pyducts Pre-Order
Slide 98
Slide 98 text
Pyducts Pre-Order
Slide 99
Slide 99 text
Pyducts Pre-Order
Slide 100
Slide 100 text
No content
Slide 101
Slide 101 text
Thank you
Slide 102
Slide 102 text
No content