Skip to content

Commit 1116ec6

Browse files
committed
docs(changelog): redesign sections, subsections, etc
1 parent 82b49e8 commit 1116ec6

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

CHANGELOG.rst

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,9 @@
1+
=========
12
Changelog
23
=========
34

45
0.10.0 (2022-05-11)
5-
-------------------
6-
7-
feature
8-
^^^^^^^
9-
- enable lint, distro packaging QA & test results transimission to codecov.io CI service
10-
11-
fix
12-
^^^
13-
- fix generated tox ini that had a hard coded value!
14-
15-
documentation
16-
^^^^^^^^^^^^^
17-
- add the changes introduced in this release
18-
- add Codacy Badge to quickly show the reported Code Quality
19-
20-
ci
21-
^^
22-
- enable test workflow for tags matching pattern "v*", pull requests to dev & pushes to ci branch
23-
- add job to generate the Biskotaki Python Package from this Template
24-
25-
26-
0.9.1 (2022-05-09)
27-
------------------
6+
===================
287

298
Enhance the Template's project generated CI config, by adding extra `checks` in Test Jobs and
309
automating the `integration` with the `codecov.io` hosting service.
@@ -50,49 +29,73 @@ the Test Suite.
5029
level, interactive charts of the `coverage` evolution and more.
5130

5231
ci
53-
^^
32+
--
5433
Apply the same CI additions as the ones added for the Template project (see above)!
5534
Namely:
5635

5736
- extra `checks` in the `Test Jobs`
5837
- `integration` with the `codecov.io` Code Coverage hosting service
5938

6039
documentation
61-
^^^^^^^^^^^^^
40+
-------------
6241
Add some "juicy" **code badges** in `README`, to demonstrate the `status` reported by
63-
the various `CI services` that this repository integrates with.
42+
the various `CI services` that this repository integrates with. The badges are updated
43+
automatically, as their respective status reporting (web) service `continuously integrates`
44+
(ie triggers per commit) with the `cookiecutter-python-package` Project.
6445

65-
- add badges demonstrating code coverage percentage & code quality reported CI services
46+
Changes
47+
^^^^^^^
48+
49+
feature
50+
"""""""
51+
- enable lint, distro packaging QA & test results transimission to codecov.io CI service
52+
53+
fix
54+
"""
55+
- fix generated tox ini that had a hard coded value!
56+
57+
documentation
58+
"""""""""""""
59+
- add the changes introduced in this release
60+
- add Codacy Badge to quickly show the reported Code Quality
61+
62+
ci
63+
""
64+
- enable test workflow for tags matching pattern "v*", pull requests to dev & pushes to ci branch
65+
- add job to generate the Biskotaki Python Package from this Template
6666

6767

6868
0.9.0 (2022-05-09)
69-
------------------
69+
==================
7070

71-
feature
71+
Changes
7272
^^^^^^^
73+
74+
feature
75+
"""""""
7376
- update generated .gitignore
7477
- add lint check and lint apply tox envs in the generated project
7578
- document the project structure, test infra and ci as changelog entry
7679

7780
fix
78-
^^^
81+
"""
7982
- fix the generated tox ini multifactor environments
8083
- add contributing and license rules for generated package
8184

8285
test
83-
^^^^
86+
""""
8487
- skip test cases needing internet connection for default Test Suite execution
8588
- add test case for running without initializing git repository
8689
- define a test case where we run tox for a newly generated project
8790
- 73% code coverage
8891

8992
documentation
90-
^^^^^^^^^^^^^
93+
"""""""""""""
9194
- document the get_object fixture
9295
- add instructions on how to Check Lint Rules and apply Lint fixes to satisfy them
9396

9497
ci
95-
^^
98+
""
9699
- ignore post_gen_project.py script because the templated vars make black complain
97100
- add lint check in Test Workflow
98101
- add lint environment, which can check & fix code following our Code Style/Linting strategy
@@ -105,17 +108,20 @@ ci
105108

106109

107110
0.8.3 (2022-04-29)
108-
------------------
111+
==================
112+
113+
Changes
114+
^^^^^^^
109115

110116
docs
111-
^^^^
117+
""""
112118
- add CONTRIBUTING.md
113119

114120
dev
115-
^^^
121+
"""
116122
- add configuration for code static analysis with `pylint`
117123
- add configuration for code static analysis with `prospector`
118124

119125
ci
120-
^^
126+
""
121127
- add type checking all CI Jobs

0 commit comments

Comments
 (0)