Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.52 KB

RELEASES.md

File metadata and controls

51 lines (32 loc) · 1.52 KB

Release Process

Release versions for @slate-ui/core follow Semver. To create a new release, use the following process.

  1. Commit and push changes on develop or a feature branch.

  2. Update version number in package.json and update CHANGELOG.md.

  3. Create a pull request against master, then merge with a merge commit.

  4. Tag the release using git tag with the current version number.

git tag v2.1.0
  1. If everything looks good, push tags to GitHub.
git push origin master --tags
  1. In GitHub, create a release from the new tag in the following format.

Title:

v2.0.0

Description (copy directly from CHANGELOG):

## v2.0.0 (June 21, 2019)

- BREAKING: Changed default class for results list from `autocomplete-results` to `autocomplete-result-list`
- BREAKING: Changed default ID for results list from `autocomplete-results-{id}` to `autocomplete-result-list-{id}`
- BREAKING: Call `search` function on focus

### autocomplete

- BREAKING: Updated default slot to control template for entire component
- BREAKING: Added new slot called `result` to control template for a single result item
- BREAKING: Removed `onSubmit` prop to use custom `submit` event instead

### button

- BREAKING: Removed `renderResults` option and replaced with `renderResult`, which can be used to control rendering of a single result item. This function can return either a DOM element or an HTML string.

After creating the release, a GitHub action will run to publish the release to npm.