8
8
<a href =" https://github.com/psf/black " ><img src =" https://img.shields.io/badge/code%20style-black-000000.svg " alt =" Code style: black " height =" 18 " ></a >
9
9
</p >
10
10
11
-
12
11
# Install
13
12
14
13
To install
@@ -28,6 +27,7 @@ gitcommit
28
27
The purpose of this utility is to expedite the process of committing with a conventional message format in a user friendly way. This tool is not templated, because it sticks rigidly to the [ Conventional Commit standard] ( https://www.conventionalcommits.org ) , and thus not designed to be 'altered' on a case by case basis.
29
28
30
29
Commit messages produced follow the general template:
30
+
31
31
```
32
32
<type>[(optional scope)]: <description>
33
33
@@ -47,7 +47,7 @@ Additional rules implemeted:
47
47
The old distribution method is documented in
48
48
[ docs/dev_distibution_legacy.md] ( docs/dev_distribution_legacy.md )
49
49
50
- * Note : if modifying ` .travis.yml ` you should verify it by running ` travis lint .travis.yml ` *
50
+ _ Note : if modifying ` .travis.yml ` you should verify it by running ` travis lint .travis.yml ` _
51
51
52
52
## Getting started
53
53
@@ -62,33 +62,35 @@ The old distribution method is documented in
62
62
1 . ` pre-commit install `
63
63
64
64
1 . It is highly recommend you enable setting for storing the venvs within your projects.
65
- ```
66
- poetry config settings.virtualenvs.in-project true
67
- ```
65
+
66
+ ```
67
+ poetry config virtualenvs.in-project true
68
+ ```
68
69
69
70
1 . Install project dependencies.
70
- ```
71
- poetry install
72
- ```
71
+ ```
72
+ poetry install
73
+ ```
73
74
74
75
## Running the package locally
75
76
76
77
1 . Activate the virtual environment.
77
- ```
78
- source .venv/bin/activate
79
- ```
78
+
79
+ ```
80
+ source .venv/bin/activate
81
+ ```
80
82
81
83
1 . Run the package as a module.
82
- ```
83
- python -m gitcommit
84
- ```
84
+ ```
85
+ python -m gitcommit
86
+ ```
85
87
86
88
Alternatively,
87
89
88
90
1 . Run the package using Poetry's venv as context
89
- ```
90
- poetry run python -m gitcommit
91
- ```
91
+ ```
92
+ poetry run python -m gitcommit
93
+ ```
92
94
93
95
Or, if in another directory,
94
96
@@ -99,17 +101,22 @@ Or, if in another directory,
99
101
## Deploy
100
102
101
103
Deployment is handled automatically by Travis CI. It has been linked to the
102
- repository and is automatically watching for pushes to master. It will build and
103
- test every commit to master. It will also build every tagged commit as if it was
104
- a branch, and since its a tagged commit, will attempt to publish it to PyPI.
104
+ repository and is automatically watching for pushes to master. It will build
105
+ and test every commit to master. It will also build every tagged commit as
106
+ if it was a branch, and since its a tagged commit, will attempt to publish
107
+ it to PyPI.
105
108
106
109
1. Don't forget to increment version number set in `pyproject.toml`. This can be
107
110
done with poetry.
111
+
108
112
```
109
113
poetry version [ patch|minor|major]
110
114
```
111
115
116
+ 1. Update the version number as stored in the `gitcommit/__version__.py` file to match that designated by Poetry.
117
+
112
118
1. Tag the commit (by default applies to HEAD commit - make sure you are on the latest `develop` commit).
119
+
113
120
```
114
121
git tag v#.#.#
115
122
```
0 commit comments