Skip to content

Commit 0e292b2

Browse files
committed
📚 update change log and readme
1 parent 5bf8f3b commit 0e292b2

File tree

4 files changed

+17
-26
lines changed

4 files changed

+17
-26
lines changed

CHANGELOG.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
Change log
22
================================================================================
33

4-
0.0.12 - tbd
4+
0.0.12 - 26.08.20220
55
--------------------------------------------------------------------------------
66

77
**added**
88

99
#. `#143 <https://github.com/moremoban/pypi-mobans/issues/143>`_: include python
1010
setup.py checkdocs
11+
#. auto-generation of contributors
12+
#. github action for moban update and commits
13+
#. better isort action
14+
#. added checkdocs action before generating a distribution package
1115

1216
0.0.11 - 03.05.2020
1317
--------------------------------------------------------------------------------

README.rst

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ update accurately using `moban`_. Here is a list of features:
2323
#. core python package
2424
#. test configuration setup
2525
#. ready to commit github repository
26-
#. automated upload to pypi through twine
26+
#. automated upload to pypi via github actions
2727
#. version management through jinja2
28-
#. automated github release through gease
29-
28+
#. automatic extraction of github contributors
29+
#. semi-automatic change log generation
3030

3131
It is used with `yehua <https://github.com/chfw/yehua>`_.
3232
Organisations using it:
@@ -125,22 +125,6 @@ In order to make moban updates: please call `make`.
125125
User guides
126126
================================================================================
127127

128-
Release and publish from command line
129-
--------------------------------------------------------------------------------
130-
131-
In order to run, `python setup.py publish`, you will have setup `.pypirc` in
132-
your home folder as::
133-
134-
[distutils]
135-
index-servers =
136-
pypi
137-
138-
[pypi]
139-
username=your_name
140-
password=your_password
141-
142-
143-
And you need to configure `gease`.
144128

145129
Auto publishing via github action
146130
--------------------------------------------------------------------------------
@@ -170,13 +154,11 @@ Using dependency markers in `setup.py`
170154
In order to use dependency markers in `setup.py`, add `setup_use_markers: true`
171155
in your `mobanfile.
172156

173-
174-
Auto generate contributors
157+
Auto generation of contributors
175158
--------------------------------------------------------------------------------
176159

177-
Github has a record all contributors, hence it is possible to generate
178-
contributors list from github call.
179-
160+
You must specify an author in your configuration file, otherwise contributors
161+
will include author.
180162

181163
Developer Guides
182164
================================================================================

changelog.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ releases:
55
- action: added
66
details:
77
- "`#143`: include python setup.py checkdocs"
8-
date: tbd
8+
- auto-generation of contributors
9+
- github action for moban update and commits
10+
- better isort action
11+
- added checkdocs action before generating a distribution package
12+
date: 26.08.20220
913
version: 0.0.12
1014
- changes:
1115
- action: Updated

templates/tests/requirements.txt.jj2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ isort
88
collective.checkdocs
99
pygments
1010
moban
11+
moban_jinja2_github
1112
{% for dependency in test_dependencies: %}
1213
{{dependency}}
1314
{% endfor %}

0 commit comments

Comments
 (0)