Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/how-to-release.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# How to release dash-bootstrap-components

This is a set of instructions for releasing _dash-bootstrap-components_. The release process is somewhat automated with an [`invoke`](http://docs.pyinvoke.org/en/latest/getting_started.html>) task file. You will need `invoke` and `semver` installed.
This is a set of instructions for releasing _dash-bootstrap-components_. The release process is somewhat automated with [`just`](https://github.com/casey/just)

- Run `invoke prerelease <version>`, where `version` is the version number of the release candidate. If you are aiming to release version `0.0.7`, this will be `0.0.7-rc1`. This will automatically bump the version numbers and push a release branch to GitHub.
- Run `just prerelease <version>`, where `version` is the version number of the release candidate. If you are aiming to release version `0.0.7`, this will be `0.0.7-rc1`. This will automatically bump the version numbers and push a release branch to GitHub.

- Create a pull request with this branch, and document changes in the release in the comment of your pull request. The title and comment of the pull request are used by GitHub Actions to make the release on GitHub. See the other releases or the [changelog](https://dash-bootstrap-components.opensource.faculty.ai/changelog/) for previous release summaries.

- Merge the pull request. This will trigger a GitHub Action that will build the package and upload to PyPI.

- Verify that you can install the new version and that it works correctly with `pip install dash-bootstrap-components==<new version>`. It's best to verify the installation on a clean virtual machine (rather than just in a new environment) since installation is more complex than for pure Python packages.
- Verify that you can install the new version and that it works correctly with `pip install dash-bootstrap-components==<new version>`.

- If the manual installation tests failed, fix the issue and repeat the previous steps with `rc2` etc. If installing worked, proceed to the next steps.

- Run `invoke release <version>`, where `version` is the version number of the release (e.g. `0.7.0`). This will push a release branch to GitHub.
- Run `just release <version>`, where `version` is the version number of the release (e.g. `0.0.7`). This will push a release branch to GitHub.

- As before, open a pull request and use the title and comment to document changes to the package. When the pull request is merged GitHub Actions will build the packages and upload it to PyPI.

Expand All @@ -23,5 +23,5 @@ This is a set of instructions for releasing _dash-bootstrap-components_. The rel
The documentation is currently hosted on Heroku. To push documentation updates:

```sh
invoke documentation
just deploy-docs
```
4 changes: 2 additions & 2 deletions src/components/breadcrumb/Breadcrumb.js
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ Breadcrumb.propTypes = {
key: PropTypes.string,

/**
* **DEPRECATED** - Use class_name instead.
* **DEPRECATED** Use `class_name` instead.
*
* Additional CSS classes to apply to the Breadcrumb.
*/
className: PropTypes.string,

/**
* **DEPRECATED** - use item_class_name instead.
* **DEPRECATED** Use `item_class_name` instead.
*
* Additional CSS classes to apply to each item.
*/
Expand Down
3 changes: 2 additions & 1 deletion src/components/carousel/Carousel.js
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,8 @@ Carousel.propTypes = {
/**
* **DEPRECATED** Use `class_name` instead.
*
* efines the className of the carousel container. Additional CSS classes to apply to the Carousel.
* Defines the className of the carousel container. Additional CSS classes
* to apply to the Carousel.
*/
className: PropTypes.string,

Expand Down
2 changes: 1 addition & 1 deletion src/components/dropdownmenu/DropdownMenu.js
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ DropdownMenu.propTypes = {
/**
* **DEPRECATED** Use `toggle_class_name` instead.
*
* Additional CSS classes to apply to the DropdownMenu The classes
* Additional CSS classes to apply to the DropdownMenu. The classes
* specified with this prop will be applied to the DropdownMenu toggle.
*/
toggleClassName: PropTypes.string,
Expand Down
18 changes: 9 additions & 9 deletions src/components/input/Textarea.js
Original file line number Diff line number Diff line change
Expand Up @@ -373,49 +373,49 @@ Textarea.propTypes = {
className: PropTypes.string,

/**
* **DEPRECATED** Use `accesskey` instead
* **DEPRECATED** Use `accesskey` instead.
*
* Defines a keyboard shortcut to activate or add focus to the element.
*/
accessKey: PropTypes.string,

/**
* **DEPRECATED** Use `autofocus` instead
* **DEPRECATED** Use `autofocus` instead.
*
* The element should be automatically focused after the page loaded.
*/
autoFocus: PropTypes.string,

/**
* **DEPRECATED** Use `contenteditable` instead
* **DEPRECATED** Use `contenteditable` instead.
*
* Indicates whether the element's content is editable.
*/
contentEditable: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),

/**
* **DEPRECATED** Use `contextmenu` instead
* **DEPRECATED** Use `contextmenu` instead.
*
* Defines the ID of a <menu> element which will serve as the element's context menu.
*/
contextMenu: PropTypes.string,

/**
* **DEPRECATED** Use `maxlength` instead
* **DEPRECATED** Use `maxlength` instead.
*
* Defines the maximum number of characters allowed in the element.
*/
maxLength: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),

/**
* **DEPRECATED** Use `minlength` instead
* **DEPRECATED** Use `minlength` instead.
*
* Defines the minimum number of characters allowed in the element.
*/
minLength: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),

/**
* **DEPRECATED** Use `readonly` instead
* **DEPRECATED** Use `readonly` instead.
*
* Indicates whether the element can be edited.
*/
Expand All @@ -425,7 +425,7 @@ Textarea.propTypes = {
]),

/**
* **DEPRECATED** Use `spellcheck` instead
* **DEPRECATED** Use `spellcheck` instead.
*
* Indicates whether spell checking is allowed for the element.
*/
Expand All @@ -436,7 +436,7 @@ Textarea.propTypes = {
]),

/**
* **DEPRECATED** Use `tabindex` instead
* **DEPRECATED** Use `tabindex` instead.
*
* Overrides the browser's default tab order and follows the one specified instead.
*/
Expand Down
22 changes: 11 additions & 11 deletions src/components/modal/Modal.js
Original file line number Diff line number Diff line change
Expand Up @@ -206,68 +206,68 @@ Modal.propTypes = {
/**
* **DEPRECATED** Use `dialog_style` instead.
*
* Inline CSS styles to apply to the dialog
* Inline CSS styles to apply to the dialog.
*/
dialogStyle: PropTypes.object,

/**
* **DEPRECATED** Use `content_style` instead.
*
* Inline CSS styles to apply to the content
* Inline CSS styles to apply to the content.
*/
contentStyle: PropTypes.object,

/**
* **DEPRECATED** Use `content_style` instead.
* **DEPRECATED** Use `backdrop_style` instead.
*
* Inline CSS styles to apply to the backdrop
* Inline CSS styles to apply to the backdrop.
*/
backdropStyle: PropTypes.object,

/**
* **DEPRECATED** Use `class_name` instead.
*
* Additional CSS classes to apply to the Modal
* Additional CSS classes to apply to the Modal.
*/
className: PropTypes.string,

/**
* **DEPRECATED** Use `backdrop_class_name` instead
* **DEPRECATED** Use `backdrop_class_name` instead.
*
* Additional CSS classes to apply to the modal-backdrop.
*/
backdropClassName: PropTypes.string,

/**
* **DEPRECATED** Use `content_class_name` instead
* **DEPRECATED** Use `content_class_name` instead.
*
* Additional CSS classes to apply to the modal-content.
*/
contentClassName: PropTypes.string,

/**
* **DEPRECATED** Use `dialog_class_name` instead
* **DEPRECATED** Use `dialog_class_name` instead.
*
* Additional CSS classes to apply to the modal-dialog.
*/
dialogClassName: PropTypes.string,

/**
* **DEPRECATED** Use `autofocus` instead
* **DEPRECATED** Use `autofocus` instead.
*
* Puts the focus on the modal when initialized.
*/
autoFocus: PropTypes.bool,

/**
* **DEPRECATED** Use `labelledby` instead
* **DEPRECATED** Use `labelledby` instead.
*
* The ARIA labelledby attribute
*/
labelledBy: PropTypes.string,

/**
* **DEPRECATED** Use `zindex` instead
* **DEPRECATED** Use `zindex` instead.
*
* Set the z-index of the modal. Default 1050.
*/
Expand Down
8 changes: 4 additions & 4 deletions src/components/offcanvas/Offcanvas.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,28 +136,28 @@ Offcanvas.propTypes = {
labelledby: PropTypes.string,

/**
* **DEPRECATED** - Use class_name instead.
* **DEPRECATED** Use `class_name` instead.
*
* Additional CSS classes to apply to the Offcanvas
*/
className: PropTypes.string,

/**
* **DEPRECATED** - Use backdrop_class_name instead.
* **DEPRECATED** Use `backdrop_class_name` instead.
*
* CSS class to apply to the backdrop.
*/
backdropClassName: PropTypes.string,

/**
* **DEPRECATED** Use `autofocus` instead
* **DEPRECATED** Use `autofocus` instead.
*
* Puts the focus on the modal when initialized.
*/
autoFocus: PropTypes.bool,

/**
* **DEPRECATED** Use `labelledby` instead
* **DEPRECATED** Use `labelledby` instead.
*
* The ARIA labelledby attribute
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/pagination/Pagination.js
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ Pagination.propTypes = {
class_name: PropTypes.string,

/**
* **DEPRECATED** - Use class_name instead.
* **DEPRECATED** Use `class_name` instead.
*
* Additional CSS classes to apply to the Pagination.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/components/spinner/Spinner.js
Original file line number Diff line number Diff line change
Expand Up @@ -259,14 +259,14 @@ Spinner.propTypes = {
),

/**
* **DEPRECATED** - use `fullscreen_class_name` instead.
* **DEPRECATED** Use `fullscreen_class_name` instead.
*
* Additional CSS classes to apply to the Spinner when fullscreen=True.
*/
fullscreenClassName: PropTypes.string,

/**
* **DEPRECATED** - use `spinner_class_name` instead.
* **DEPRECATED** Use `spinner_class_name` instead.
*
* CSS class names to apply to the spinner.
*/
Expand Down
8 changes: 4 additions & 4 deletions src/components/tabs/Tab.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,15 +115,15 @@ Tab.propTypes = {
className: PropTypes.string,

/**
* **DEPRECATED** Use `tab_class_name` instead
* **DEPRECATED** Use `tab_class_name` instead.
*
* Additional CSS classes to apply to the Tabs. The classes
* specified with this prop will be applied to the NavItem in the tab.
*/
tabClassName: PropTypes.string,

/**
* **DEPRECATED** Use `active_tab_class_name` instead
* **DEPRECATED** Use `active_tab_class_name` instead.
*
* Additional CSS classes to apply to the Tabs. The classes
* specified with this prop will be applied to the NavItem in the tab when it
Expand All @@ -132,15 +132,15 @@ Tab.propTypes = {
activeTabClassName: PropTypes.string,

/**
* **DEPRECATED** Use `label_class_name` instead
* **DEPRECATED** Use `label_class_name` instead.
*
* Additional CSS classes to apply to the Tabs. The classes
* specified with this prop will be applied to the NavLink in the tab.
*/
labelClassName: PropTypes.string,

/**
* **DEPRECATED** Use `active_label_class_name` instead
* **DEPRECATED** Use `active_label_class_name` instead.
*
* Additional CSS classes to apply to the Tabs. The classes
* specified with this prop will be applied to the NavLink in the tab when
Expand Down
4 changes: 2 additions & 2 deletions src/components/toast/Toast.js
Original file line number Diff line number Diff line change
Expand Up @@ -228,15 +228,15 @@ Toast.propTypes = {
className: PropTypes.string,

/**
* **DEPRECATED** - use `header_class_name` instead
* **DEPRECATED** Use `header_class_name` instead.
*
* Additional CSS classes to apply to the Toast. The classes
* specified with this prop will be applied to the header of the toast.
*/
headerClassName: PropTypes.string,

/**
* **DEPRECATED** - use `body_class_name` instead.
* **DEPRECATED** Use `body_class_name` instead.
*
* Additional CSS classes to apply to the Toast. The classes
* specified with this prop will be applied to the body of the toast.
Expand Down
Loading