Skip to content

Commit

Permalink
New changelog fragment (#132)
Browse files Browse the repository at this point in the history
  • Loading branch information
antonymilne authored Oct 26, 2023
1 parent b2be72f commit 56e2108
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 2 deletions.
1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
- [ ] I have not referenced individuals, products or companies in any commits, directly or indirectly
- [ ] I have not added data or restricted code in any commits, directly or indirectly
- [ ] I have updated the docstring of any public function/class/model changed
- [ ] I have added the PR number to the change description in the changelog fragment, e.g. `Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))` (if applicable)
- [ ] I have added tests to cover my changes (if applicable)

## Types of changes
Expand Down
2 changes: 1 addition & 1 deletion tools/check_package_release.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def _check_no_dev_version(package_name, package_version):

if _check_no_dev_version(package_name, package_version) and _check_no_version_pypi(
package_name, package_version
):
):
if new_release:
sys.exit("Cannot release two packages at the same time. Please modify your PR.")
new_release = True
Expand Down
8 changes: 8 additions & 0 deletions vizro-core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse
## Changed

- Move creation of `dash.page_registry` to `Dashboard.pre_build` ([#74](https://github.com/mckinsey/vizro/pull/74))

- Change the default collapsible behavior and highlighting color of the selected accordion group ([#74](https://github.com/mckinsey/vizro/pull/74))

## Fixed
Expand Down Expand Up @@ -144,11 +145,17 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse
## Added

- Add Vizro templates and enable choice of `light` and `dark` themes

- Enable integration of plotly express charts within Graph

- Enable data connections via Kedro data catalog

- Add ModelManager and DataManager class

- Add the Vizro class and enable parsing and running a dashboard

- Add the following pydantic models:

- Action
- Button
- Card
Expand All @@ -165,4 +172,5 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse
- RangeSlider
- Slider
- VizroBaseModel

- Enable the addition and usage of custom components and custom charts
42 changes: 42 additions & 0 deletions vizro-core/changelog.d/20231026_130425_antony.milne_scriv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Removed
- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Added
- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Changed
- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Deprecated
- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Fixed
- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Security
- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
14 changes: 14 additions & 0 deletions vizro-core/changelog.d/new_fragment.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

{% for cat in config.categories -%}
<!--
### {{ cat }}
- A bullet item for the {{ cat }} category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
{% endfor -%}
1 change: 1 addition & 0 deletions vizro-core/changelog.d/scriv.ini
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[scriv]
version = literal: src/vizro/__init__.py: __version__
format = md
categories = Highlights ✨, Removed, Added, Changed, Deprecated, Fixed, Security

0 comments on commit 56e2108

Please sign in to comment.