Skip to content

Commit faadf6c

Browse files
committed
Added changelog and build notes
1 parent 5825491 commit faadf6c

4 files changed

Lines changed: 75 additions & 4 deletions

File tree

CHANGELOG.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Changelog
2+
=========
3+
4+
All notable changes to this project will be documented in this file.
5+
6+
The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
7+
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
8+
9+
Unreleased_
10+
-----------
11+
12+
Nothing yet
13+
14+
15+
3.0_ - 2021-07-05
16+
-----------------
17+
18+
Added:
19+
20+
- More documentation #14
21+
22+
Fixed:
23+
24+
- Mbbi/o specifying alarm values bug introduced in 3.0b2 #15
25+
26+
27+
3.0b2_ - 2021-06-28
28+
-------------------
29+
30+
Changed:
31+
32+
- Restructured the docs #9 #10
33+
34+
Removed:
35+
36+
- Option of specifying scalar value for mbbi and mbbo records
37+
38+
39+
3.0b1_ - 2021-06-28
40+
-------------------
41+
42+
Port to being a Python package #5
43+
44+
Changed:
45+
46+
- Removed ability to build as an EPICS module
47+
- Restructure C code as Python extension
48+
- Make devIocStats a submodule
49+
- Now has a hard dependency on epicscorelibs
50+
51+
Added:
52+
53+
- asyncio support
54+
55+
56+
2-16_ - 2019-12-10
57+
------------------
58+
59+
Last release as an EPICS module rather than a Python package
60+
61+
62+
.. _Unreleased: https://github.com/dls-controls/pythonIoc/compare/3.0...HEAD
63+
.. _3.0: https://github.com/dls-controls/pythonIoc/compare/3.0b2...3.0
64+
.. _3.0b2: https://github.com/dls-controls/pythonIoc/compare/3.0b1...3.0b2
65+
.. _3.0b1: https://github.com/dls-controls/pythonIoc/compare/2-16...3.0b1
66+
.. _2-16: https://github.com/dls-controls/pythonIoc/releases/tag/2-16

CONTRIBUTING.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,15 @@ You can build the docs from the project directory by running::
6363
$ firefox build/html/index.html
6464

6565

66-
Release Checklist
67-
-----------------
66+
Release Process
67+
---------------
6868

69-
Before a new release, please go through the following checklist:
69+
To make a new release, please go through the following checklist:
7070

7171
- Choose a new PEP440 compliant release number
7272
- Git tag the version with a message summarizing the changes
7373
- Push to github and the actions will make a release on pypi
74-
- Push to internal gitlab and do a dls-release.py of the tag
74+
- Push to internal gitlab but do not release from there
75+
- Run ``dls-py3 download-one-dependency softioc <release>``
76+
- Run ``cp Pipfile.lock /dls_sw/work/python3/RHEL7-x86_64/distributions/softioc-<release>.Pipfile.lock``
77+
- Run ``dls-release.py -a python3ext softioc <release>``

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Table Of Contents
7777
:maxdepth: 1
7878

7979
reference/api
80+
reference/changelog
8081
reference/contributing
8182

8283
* :ref:`genindex`

docs/reference/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../CHANGELOG.rst

0 commit comments

Comments
 (0)