Skip to content

Commit 1332748

Browse files
authored
Create changelog process (rjsf-team#2563)
* Create changelog process * Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md * Update contributing.md * Update CHANGELOG.md
1 parent 98df72f commit 1332748

File tree

3 files changed

+57
-2
lines changed

3 files changed

+57
-2
lines changed

CHANGELOG.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<!--
2+
3+
INSTRUCTIONS:
4+
5+
For each PR, add a changelog entry that describes what your PR does. Add it to the heading
6+
for the appropriate package it modifies and include it in this format:
7+
- [Description] ([Link to PR])
8+
9+
If your PR affects multiple packages, list it multiple times under headings for each package.
10+
If it affects more general things such as dependency updates or non-package-specific changes,
11+
add it under a "Dev / docs / playground" section.
12+
13+
You should also update the heading of the latest (upcoming) version if your PR change merits
14+
it according to semantic versioning. For example, if your PR adds a breaking change, then you
15+
should change the heading of the (upcoming) version to include a major version bump.
16+
17+
-->
18+
19+
# v3.2.0 (upcoming)
20+
21+
## @rjsf/core
22+
- Fix for clearing errors after updating and submitting form (https://github.com/rjsf-team/react-jsonschema-form/pull/2536)
23+
- bootstrap-4 TextWidget wrappers now pull from registry, add rootSchema to Registry, fix FieldProps.onFocus type to match WidgetProps (https://github.com/rjsf-team/react-jsonschema-form/pull/2519)
24+
25+
## @rjsf/bootstrap-4
26+
- bootstrap-4 TextWidget wrappers now pull from registry, add rootSchema to Registry, fix FieldProps.onFocus type to match WidgetProps (https://github.com/rjsf-team/react-jsonschema-form/pull/2519)
27+
28+
## @rjsf/fluent-ui
29+
- fluent-ui: Allow value of 0 in TextWidget (https://github.com/rjsf-team/react-jsonschema-form/pull/2497)
30+
31+
## Dev / docs / playground
32+
- Several dependency updates
33+
34+
# v3.1.0
35+
36+
## @rjsf/core
37+
- Properly assign label prop for MultiSelect ArrayField (https://github.com/rjsf-team/react-jsonschema-form/pull/2459)
38+
- Take into account implicitly defined types when rendering labels for fields (https://github.com/rjsf-team/react-jsonschema-form/pull/2502)
39+
40+
## @rjsf/antd
41+
- Add default Form export to @rjsf/antd (https://github.com/rjsf-team/react-jsonschema-form/pull/2514)
42+
43+
## @rjsf/fluent-ui
44+
- Make material-ui and fluent-ui pull TextWidget from the registry; remove registry prop from <div> in TextWidget (https://github.com/rjsf-team/react-jsonschema-form/pull/2515)
45+
46+
## @rjsf/material-ui
47+
- Make material-ui and fluent-ui pull TextWidget from the registry; remove registry prop from <div> in TextWidget (https://github.com/rjsf-team/react-jsonschema-form/pull/2515)
48+
49+
## @rjsf/semantic-ui
50+
- Use getDisplayLabel to properly show labels for widgets (https://github.com/rjsf-team/react-jsonschema-form/pull/2225)
51+
- Add submit button, email, url, date widgets (https://github.com/rjsf-team/react-jsonschema-form/pull/2224)
52+
53+
## Dev / docs / playground
54+
- Several dependency updates

PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ If this is related to existing tickets, include links to them as well. Use the s
1111
* [ ] **I'm adding or updating code**
1212
- [ ] I've added and/or updated tests
1313
- [ ] I've updated [docs](https://react-jsonschema-form.readthedocs.io/) if needed
14+
- [ ] I've updated the [changelog](https://github.com/rjsf-team/react-jsonschema-form/blob/master/CHANGELOG.md) with a description of the PR
1415
* [ ] **I'm adding a new feature**
1516
- [ ] I've updated the playground with an example use of the feature
16-

docs/contributing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ lerna version
4949

5050
Make sure you use [semver](https://semver.org/) for version numbering when selecting the version.
5151
The command above will create a new version tag and push it to GitHub. Then, create a release in
52-
the Github "Releases" tab and add a description of the changes in the new release.
52+
the Github "Releases" tab and add a description of the changes in the new release. You can copy
53+
the latest changelog entry in `CHANGELOG.md` to make the release notes, and update as necessary.
5354

5455
This will trigger a GitHub Actions pipeline that will build and publish all packages to npm.
5556

0 commit comments

Comments
 (0)