Releases: xability/py-maidr
v0.6.0
v0.6.0 (2024-08-21)
Chore
- chore: add bug report and feature request templates (#81)
Added bug report and feature request templates to improve the issue creation process. These templates provide a standardized structure for reporting bugs and requesting new features, making it easier for contributors to provide clear and concise information. This will help streamline the issue triage and resolution process.
The bug report template includes sections for describing the bug, steps to reproduce, actual and expected behavior, screenshots, and additional information. The feature request template includes sections for describing the requested feature, motivation, proposed solution, and additional context.
This commit follows the established commit message convention of starting with a verb in the imperative form, followed by a brief description of the change. It also includes a type prefix ("feat") to indicate that it is a new feature.
- chore(vscode): update shiny extension (
483a075
)
Ci
Feature
v0.5.1
v0.5.0
v0.4.2
v0.4.1
v0.4.0
v0.3.0
v0.3.0 (2024-06-11)
Breaking
Chore
- chore(deps-dev): bump black from 23.3.0 to 24.3.0 (#45)
Bumps black from 23.3.0 to 24.3.0.
updated-dependencies:
- dependency-name: black
dependency-type: direct:development
...
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> (53818c9
)
Ci
- ci: add workflow for publishing docs (#44)
docs.yml
automates the publishing of py-maidr documentation to GitHub Pages. This builds the
static sources using quarto
for the website and quartodoc
for the API Reference.
The rendering and publishing are accomplished using Quarto's github actions, which can be found
at https://github.com/quarto-dev/quarto-actions.
Fix
v0.2.0
v0.2.0 (2024-05-16)
Ci
- ci: setup release pipeline (#42)
release.yml
configures the github workflow to lint the commit message, format of the code,
and the unit tests. After successfully completing those jobs, the pipeline builds the package,
updates the semantic version according to the commit message and publishes to the GitHub
Release as well as to the PyPi.
- ci: setup pr github workflow (#40)
Combined the black, commit-message-lint, and the unit test workflow into one called ci.yml. This is beneficial because it could be reused in the release pipeline.
Documentation
- docs: add quarto and quartodoc for static website (#38)
_quarto.yml
includes the base structure of the static website with a navbar and the main site. The navbar includes 'Overview', 'Get Started', and 'API Referece' sections, which are structured in _index.qmd
, _get_started.qmd
, and the quartodoc section of _quarto.yml
respectively. Currently, the 'Overview' and 'Get Started' sections are left empty, which will be generated in the upcoming releases. The 'API Reference' section will include the docstring in a neat format generated by quartodoc
.