Releases: xability/py-maidr
v0.7.0
v0.7.0 (2024-08-24)
Ci
- ci: rectify commit-lint job crash (#92)
<!-- Suggested PR Title: [feat/fix/refactor/perf/test/ci/docs/chore]
brief description of the change -->
<!-- Please follow Conventional Commits:
https://www.conventionalcommits.org/en/v1.0.0/ -->
Description
This PR resolves an issue related to the commit-lint job in
.github/workflows/ci.yml.
Closes [#91]
Type of Change
- Bug fix
- New feature
- Breaking change (fix or feature that would cause existing
functionality to not work as expected) - Documentation update
Checklist
- My code follows the style guidelines of this project
- I have performed a self-review of my code
- I have commented my code, particularly in hard-to-understand areas
- I have made corresponding changes to the documentation
- My changes generate no new warnings
- Any dependent changes have been merged and published in downstream
modules
Pull Request
Description
This PR addresses an issue where commit-lint job crashes when
validating pull requests.
Changes Made
Currently, the commitlint config file is getting loaded as an ES module
whilst it contains vanilla javascript configurations. This causes the
job to crash because it expects a common javascript config but finds an
ES module config. To address this issue The commit-lint config file has
been changed to a common-js file instead of a js file and the
conventional commit dependancy will now be installed during the job via
npm.
Screenshots (if applicable)
After making the changes, I tested the commit-lint job locally and here
is an excerpt of the execution:
(py-maidr) ➜ py_maidr git:(Krishna/fix-commitlint) act -j commit-lint -W .github/workflows/ci.yml --container-architecture linux/amd64
INFO[0000] Using docker host 'unix:///var/run/docker.sock', and daemon socket 'unix:///var/run/docker.sock'
[CI/commit-lint] 🚀 Start image=catthehacker/ubuntu:act-latest
INFO[0000] Parallel tasks (0) below minimum, setting to 1
[CI/commit-lint] 🐳 docker pull image=catthehacker/ubuntu:act-latest platform=linux/amd64 username= forcePull=true
[CI/commit-lint] using DockerAuthConfig authentication for docker pull
INFO[0001] Parallel tasks (0) below minimum, setting to 1
[CI/commit-lint] 🐳 docker create image=catthehacker/ubuntu:act-latest platform=linux/amd64 entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[CI/commit-lint] 🐳 docker run image=catthehacker/ubuntu:act-latest platform=linux/amd64 entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[CI/commit-lint] ☁ git clone 'https://github.com/wagoid/commitlint-github-action' # ref=v6
[CI/commit-lint] ⭐ Run Main actions/checkout@v3
[CI/commit-lint] 🐳 docker cp src=/Users/krishnaanandan/Desktop/maidr_krishna/py_maidr/. dst=/Users/krishnaanandan/Desktop/maidr_krishna/py_maidr
[CI/commit-lint] ✅ Success - Main actions/checkout@v3
[CI/commit-lint] ⭐ Run Main Install commitlint dependencies
[CI/commit-lint] 🐳 docker exec cmd=[bash --noprofile --norc -e -o pipefail /var/run/act/workflow/1] user= workdir=
|
| added 11 packages in 3s
|
| 1 package is looking for funding
| run `npm fund` for details
[CI/commit-lint] ✅ Success - Main Install commitlint dependencies
[CI/commit-lint] ⭐ Run Main Lint commit messages
[CI/commit-lint] 🐳 docker pull image=wagoid/commitlint-github-action:6.1.1 platform=linux/amd64 username= forcePull=true
[CI/commit-lint] using DockerAuthConfig authentication for docker pull
[CI/commit-lint] 🐳 docker create image=wagoid/commitlint-github-action:6.1.1 platform=linux/amd64 entrypoint=[] cmd=[] network="container:act-CI-commit-lint-6b355268bbbb8e27234c3c935b66fc686b070544b9a3b02b47d79688837a12ff"
[CI/commit-lint] 🐳 docker run image=wagoid/commitlint-github-action:6.1.1 platform=linux/amd64 entrypoint=[] cmd=[] network="container:act-CI-commit-lint-6b355268bbbb8e27234c3c935b66fc686b070544b9a3b02b47d79688837a12ff"
| Lint free! 🎉
[CI/commit-lint] ✅ Success - Main Lint commit messages
[CI/commit-lint] ⚙ ::set-output:: results=[]
[CI/commit-lint] Cleaning up container for job commit-lint
[CI/commit-lint] 🏁 Job succeeded
(py-maidr) ➜ py_maidr git:(Krishna/fix-commitlint)
Checklist
<!-- Please select all applicable options. -->
<!-- To select your options, please put an 'x' in the all boxes that
apply. -->
- I have read the Contributor Guidelines.
- I have performed a self-review of my own code and ensured it
follows the project's coding standards. - I have tested the changes locally following
ManualTestingProcess.md, and all tests related to this pull request
pass. - I have commented my code, particularly in hard-to-understand
areas. - I have updated the documentation, if applicable.
- I have added appropriate unit tests, if applicable. (
ae50904)
- ci(commitlint): disable commitlint line length and total length checking (#87)
Feature
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.