Skip to content

Commit

Permalink
Merge pull request #907 from SelectQuoteLabs/v9.8.x
Browse files Browse the repository at this point in the history
fix: 🐛 SQFormMultiselect isVirtualized prop is now optional
  • Loading branch information
20BBrown14 authored Jul 12, 2023
2 parents 727496b + 7140a18 commit 14c4703
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ For **BREAKING CHANGES** Type a brief description of the breaking change when as

- A breaking change will cause a `MAJOR` SemVer bump. Ex: 3.0.5 -> 4.0.0

### Maintenance Releases

Maintenance releases are for when we want to release a new version of the library that is _not_ of the latest major version. This can happen when we notice a bug in a heavily used older version, or we have a request for a new feature that needs to be in an older version.

Maintenance releases are released off any branch that includes the string `"maintenance-release"` such as `"maintenance-release-9.8.x"`. This branch naming convention is protected in repo settings.

- Create a branch off whatever your base version is with the branch naming mentioned
- Push it to remove
- Create a feature branch off that branch for your code changes
- Create a PR following normal procedures to merge your feature branch into your maintenance-release branch
- Address PR feedback and get approvals
- When the PR is merged it should automatically kick off the release Github Action. This can be verified in the actions tab on Github
- When the action is finished a new version should be available to download on [NPM]() for consumption.

## Consuming

By default in NPM v7 and above peer dependencies will be installed automatically. You can check your npm version using `npm --version` to determine the version you are using. If your version is not at least v7 you must install the peer dependencies manually.
Expand Down
2 changes: 1 addition & 1 deletion release.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
repositoryUrl: 'https://github.com/SelectQuoteLabs/SQForm.git',
// Semantic release will only release off the master branch and any branch with a name like 9.x or 7.7.x, etc
// Semantic release will only release off the master branch and any branch that includes the `maintenance-release` string.
branches: ['*maintenance-release*', 'master'],
plugins: [
'@semantic-release/commit-analyzer',
Expand Down
2 changes: 1 addition & 1 deletion src/components/SQForm/SQFormMultiSelect.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export type SQFormMultiSelectProps<TVirtualized = boolean> = BaseFieldProps & {
/** Multiselect options to select from */
children: SQFormOption[];
/** Whether the list menu items should be virtualized or not. Defaults false to ensure non-breaking changes. */
isVirtualized: TVirtualized;
isVirtualized?: TVirtualized;
/** Disabled property to disable the input if true */
isDisabled?: boolean;
/** This property will allow the end user to check a "Select All" box */
Expand Down

0 comments on commit 14c4703

Please sign in to comment.