Skip to content

Commit b3d3dd0

Browse files
[CONFIG] Update CI & README.md
1 parent 47ca4a3 commit b3d3dd0

File tree

3 files changed

+19
-4
lines changed

3 files changed

+19
-4
lines changed

.bumpversion.cfg

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
[bumpversion]
22
current_version = 0.1.2
33
commit = True
4-
message =
4+
message =
55
version bump {current_version} -> {new_version}
66
tag = True
77
tag_name = {new_version}
8-
tag_message =
8+
tag_message =
99
version bump {current_version} -> {new_version}
1010

1111
[bumpversion:file:gitlab_submodule/__version__.py]
1212
search = __version__ = '{current_version}'
1313
replace = __version__ = '{new_version}'
14+
15+
[bumpversion:file:README.md]
16+
search = >v{current_version}<
17+
replace = >v{new_version}<

.github/workflows/check_pr_title.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616
- name: Check PR title
1717
uses: Slashgear/action-check-pr-title@v3.0.0
1818
with:
19-
regexp: '^((\[MAJOR\])|(\[MINOR\])|(\[PATCH\])).+$'
19+
regexp: '^((\[MAJOR\])|(\[MINOR\])|(\[PATCH\])|(\[CONFIG\])).+$'

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# python-gitlab-submodule
1+
# python-gitlab-submodule <sub><sup>v0.1.2</sup></sub>
2+
23
List project submodules and get the commits they point to with python-gitlab.
34

45

@@ -199,3 +200,13 @@ submodule_to_subproject(
199200
) -> Subproject
200201
```
201202
Parameters: See [`iterate_subprojects(...)`](#iterate_subprojects)
203+
204+
205+
## Contributing
206+
207+
PRs are appreciated, just make sure your PR title starts with one of the
208+
following keywords so that the CI works:
209+
- `[MAJOR]`: breaking changes
210+
- `[MINOR]`: feature changes
211+
- `[PATCH]`: fixes
212+
- `[CONFIG]`: changes only related to GitHub (CI, .gitignore, etc.) -> won't trigger a package release

0 commit comments

Comments
 (0)