Skip to content

Commit 71a690c

Browse files
update changelog for first release
1 parent e38f30c commit 71a690c

File tree

1 file changed

+8
-81
lines changed

1 file changed

+8
-81
lines changed

changelog.md

Lines changed: 8 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -17,91 +17,18 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
1717
-->
1818

1919
## Released
20-
## [0.6.0] - 2023-02-22
20+
## [0.1.0] - 2023-03-09
2121
### Added
22-
- `.editorconfig` for common editor settings, see #12
23-
- `.yamllint` to lint all used YAML files, see #12
24-
- `codecov.yaml` to specify further settings and limits for the coverage
25-
- `yamllint` package to the `requirements-test.txt` file
26-
- Run YAML linter on test workflow
22+
- `const.py`, `display.py` and `typing.py` in `lcd_i2c` module
23+
- Examples and documentation
2724

2825
### Changed
29-
- Fixed uncovered YAML syntax issues in all workflow files
30-
- Removed unused files from `.gitignore` file
26+
- Several updates on setup and config files different than the template repo
3127

32-
## [0.5.0] - 2023-02-20
33-
### Added
34-
- `.readthedocs.yaml` definition file for ReadTheDocs, see #10
35-
- `docs` folder containing example files and configurations, see #10
36-
37-
## [0.4.0] - 2023-02-20
38-
### Added
39-
- `test-release` and `release` workflows create changelog based (pre-)releases, see #2
40-
- Documentation for manually creating a package and uploading it to PyPi in root README
41-
42-
### Fixed
43-
- All workflows use checkout v3 instead of v2
44-
45-
## [0.3.0] - 2022-11-03
46-
### Added
47-
- Lint package with `flake8` with [test workflow](.github/workflows/test.yaml)
48-
- CI upload status badge added to [`README`](README.md)
49-
50-
### Fixed
51-
- Remove not required packages `setuptools`, `wheel` and `build` from release
52-
and test-release workflow files
53-
- Show download of this package on badge instead of `be-modbus-wrapper`
54-
- Show `MicroPython Ok` badge instead of `Python3 Ok` in [`README`](README.md)
55-
56-
## [0.2.0] - 2022-10-22
57-
### Added
58-
- Deploy to [Test Python Package Index](https://test.pypi.org/) on every PR
59-
build with a [PEP440][ref-pep440] compliant `-rc<BUILDNUMBER>.dev<PR_NUMBER>`
60-
meta data extension, see [#5][ref-issue-5]
61-
- [Test release workflow](.github/workflows/test-release.yaml) running only on
62-
PRs is archiving and uploading built artifacts to
63-
[Test Python Package Index](https://test.pypi.org/)
64-
65-
### Changed
66-
- Built artifacts are no longer archived by the always running
67-
[test workflow](.github/workflows/test.yaml)
68-
69-
## [0.1.1] - 2022-10-16
70-
### Fixed
71-
- Move `src/be_upy_blink` to `be_upy_blink` to avoid installations into `/lib/src/be_upy_blink` on a uPy board via `upip`, see [#3][ref-issue-3]
72-
- Adjust all paths to `be_upy_blink` folder and contained files
73-
74-
## [0.1.0] - 2022-10-16
75-
### Added
76-
- This changelog file
77-
- [`.coveragerc`](.coveragerc) file
78-
- [`.flake8`](.flake8) file
79-
- [`.gitignore`](.gitignore) file bases on latest
80-
[Python gitignore template][ref-python-gitignore-template]
81-
- Default [workflows](.github/workflows)
82-
- Script to [create report directories](create_report_dirs.py)
83-
- [`unittest.cfg`](tests/unittest.cfg) file
84-
- [`requirements.txt`](requirements.txt) file to interact with the uPy board
85-
- [`requirements-test.txt`](requirements-test.txt) file to install packages for unittests
86-
- [`requirements-deploy.txt`](requirements-deploy.txt) file to install packages to deploy
87-
- Initial [`be_upy_blink`](src/be_upy_blink) package
88-
- Basic [`unittests`](tests) for package source code
89-
- Initial root [`README`](README.md)
90-
- [`setup.py`](setup.py) and [`sdist_upip.py`](sdist_upip.py) file
28+
### Removed
29+
- Not used files provided with [template repo](https://github.com/brainelectronics/micropython-i2c-lcd)
9130

9231
<!-- Links -->
93-
[Unreleased]: https://github.com/brainelectronics/micropython-package-template/compare/0.6.0...main
94-
95-
[0.6.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.6.0
96-
[0.5.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.5.0
97-
[0.4.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.4.0
98-
[0.3.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.3.0
99-
[0.2.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.2.0
100-
[0.1.1]: https://github.com/brainelectronics/micropython-package-template/tree/0.1.1
101-
[0.1.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.1.0
102-
103-
[ref-issue-5]: https://github.com/brainelectronics/micropython-package-template/issues/5
104-
[ref-issue-3]: https://github.com/brainelectronics/micropython-package-template/issues/3
32+
[Unreleased]: https://github.com/brainelectronics/micropython-i2c-lcd/compare/0.1.0...main
10533

106-
[ref-pep440]: https://peps.python.org/pep-0440/
107-
[ref-python-gitignore-template]: https://github.com/github/gitignore/blob/e5323759e387ba347a9d50f8b0ddd16502eb71d4/Python.gitignore
34+
[0.1.0]: https://github.com/brainelectronics/micropython-i2c-lcd/tree/0.6.0

0 commit comments

Comments
 (0)