Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelogs: Standardize sections #58268

Merged
merged 32 commits into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
2035568
Use trimStart over deprecated trimLeft
sirreal Jan 25, 2024
841c1eb
Rewrite all breaking change headers as "Breaking Changes"
sirreal Jan 25, 2024
91ed2df
Rewrite all bug fix headers as "Bug Fixes"
sirreal Jan 25, 2024
50bd455
Rewrite all deprecation headers as "Deprecations"
sirreal Jan 25, 2024
56c2023
Rewrite all new feature headers as "New Features"
sirreal Jan 25, 2024
757fe2a
Rewrite all new feature headers as "New Features"
sirreal Jan 25, 2024
1a95b53
Rewrite all enhancement headers as "Enhancements"
sirreal Jan 25, 2024
8aa9017
Rewrite all feature headers as "New Features"
sirreal Jan 25, 2024
2eff900
Rewrite all security headers as "Security"
sirreal Jan 25, 2024
527582f
Update all bug fix headers
sirreal Jun 17, 2024
5e103a1
Rename "polish" to "internal"
sirreal Jun 17, 2024
8197a27
Standardize "Breaking Changes" header
sirreal Jun 17, 2024
95ba954
Standardize "deprecations" header
sirreal Jun 17, 2024
04570de
Standardize "New Features" headers
sirreal Jun 17, 2024
fc4eccd
Change "Improvements" to "Enhancements"
sirreal Jun 17, 2024
f261ddd
Standardize "Enhancements" headers
sirreal Jun 17, 2024
1b521c2
Change "Refactor" to "Internal"
sirreal Jun 17, 2024
6cc1ff0
Update "Requirements" to "Breaking Changes"
sirreal Jun 17, 2024
d57b398
Change "New API" to "New Features"
sirreal Jun 17, 2024
b2b8f5e
Update documented section headers and add "Deprecations"
sirreal Jun 17, 2024
0d1b7b3
Fix root changelog headings and structure
sirreal Jun 18, 2024
b3f1cc5
Fix changelog headers with wrong level
sirreal Jun 18, 2024
27a2c6f
Clean up whitespace in changelog
sirreal Jun 18, 2024
789f220
Standardize on "First-time contributors"
sirreal Jun 18, 2024
d374a21
Update script to use "first-time contributor"
sirreal Jun 18, 2024
5686e54
Remove surrounding "**" from headings
sirreal Jun 18, 2024
5b07c05
Standardize changelog.txt headers and structure more
sirreal Jun 18, 2024
bfb56cb
Update unit test snapshots
sirreal Jun 18, 2024
11638dd
Update new "Enhancement" header to "Enhancements"
sirreal Jun 18, 2024
3b382b4
Update "New features" to "New Features"
sirreal Jun 18, 2024
f8252a9
Change "Backward Compatibility" to "Bug Fixes"
sirreal Jun 18, 2024
36ddedc
Change "Code Quality" to "Internal"
sirreal Jun 18, 2024
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
4 changes: 2 additions & 2 deletions bin/plugin/commands/changelog.js
Original file line number Diff line number Diff line change
Expand Up @@ -961,9 +961,9 @@ function getContributorProps( pullRequests ) {
}

return (
'## First time contributors' +
'## First-time contributors' +
'\n\n' +
'The following PRs were merged by first time contributors:' +
'The following PRs were merged by first-time contributors:' +
'\n\n' +
contributorsList
);
Expand Down
2 changes: 1 addition & 1 deletion bin/plugin/commands/common.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function calculateVersionBumpFromChangelog(
let changesDetected = false;
let versionBump = null;
for ( const line of lines ) {
const lineNormalized = line.toLowerCase().trimLeft();
const lineNormalized = line.toLowerCase().trimStart();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is replacing a deprecated String method (alias) with its recommended replacement.

// Detect unpublished changes first.
if ( lineNormalized.startsWith( '## unreleased' ) ) {
changesDetected = true;
Expand Down
706 changes: 389 additions & 317 deletions changelog.txt

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions packages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,11 @@ _Example:_

There are a number of common release subsections you can follow. Each is intended to align to a specific meaning in the context of the [Semantic Versioning (`semver`) specification](https://semver.org/) the project adheres to. It is important that you describe your changes accurately, since this is used in the packages release process to help determine the version of the next release.

- "Breaking Change" - A backwards-incompatible change which requires specific attention of the impacted developers to reconcile (requires a major version bump).
- "New Feature" - The addition of a new backwards-compatible function or feature to the existing public API (requires a minor version bump).
- "Enhancement" - Backwards-compatible improvements to existing functionality (requires a minor version bump).
- "Bug Fix" - Resolutions to existing buggy behavior (requires a patch version bump).
- "Breaking Changes" - A backwards-incompatible change which requires specific attention of the impacted developers to reconcile (requires a major version bump).
- "New Features" - The addition of a new backwards-compatible function or feature to the existing public API (requires a minor version bump).
- "Enhancements" - Backwards-compatible improvements to existing functionality (requires a minor version bump).
- "Deprecations" - Deprecation notices. These do not impact the public interface or behavior of the module (requires a minor version bump).
- "Bug Fixes" - Resolutions to existing buggy behavior (requires a patch version bump).
- "Internal" - Changes which do not have an impact on the public interface or behavior of the module (requires a patch version bump).

While other section naming can be used when appropriate, it's important that are expressed clearly to avoid confusion for both the packages releaser and third-party consumers.
Expand Down
8 changes: 4 additions & 4 deletions packages/a11y/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,22 +137,22 @@

## 2.9.0 (2020-04-15)

### New feature
### New Features

- Include TypeScript type declarations ([#18942](https://github.com/WordPress/gutenberg/pull/18942))

## 2.0.0 (2018-09-05)

### Breaking Change
### Breaking Changes

- Change how required built-ins are polyfilled with Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)). If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods.

## 1.1.0 (2018-07-12)

### New feature
### New Features

- Updated build to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))

### Polish
### Internal

- Moved `@WordPress/packages` repository to `@WordPress/gutenberg` ([#7805](https://github.com/WordPress/gutenberg/pull/7805))
2 changes: 1 addition & 1 deletion packages/annotations/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@

## 1.24.0 (2020-12-17)

### New Feature
### New Features

- Added a store definition `store` for the annotations namespace to use with `@wordpress/data` API ([#26655](https://github.com/WordPress/gutenberg/pull/26655)).

Expand Down
14 changes: 7 additions & 7 deletions packages/api-fetch/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@

## 6.0.0 (2022-01-27)

### Breaking changes
### Breaking Changes

`OPTIONS` requests handled by the preloading middleware are now resolved as `window.Response` objects if you explicitly set `parse: false` (for consistency with how GET requests are resolved). They used to be resolved as `Plain Old JavaScript Objects`.

Expand All @@ -134,7 +134,7 @@

## 5.2.0 (2021-07-21)

### New feature
### New Features

- `AbortError` being thrown by the default fetch handler can now be caught and handled separately in user-land. Add documentation about aborting a request ([#32530](https://github.com/WordPress/gutenberg/pull/32530)).

Expand All @@ -161,7 +161,7 @@

## 3.23.0 (2021-04-06)

### New Feature
### New Features

- Publish TypeScript definitions.

Expand All @@ -184,7 +184,7 @@

- A created nonce middleware will no longer automatically listen for `heartbeat.tick` actions. Assign to the new `nonce` middleware property instead.

### New Feature
### New Features

- The function returned by `createNonceMiddleware` includes an assignable `nonce` property corresponding to the active nonce to be used.
- Default fetch handler can be overridden with a custom fetch handler
Expand All @@ -203,18 +203,18 @@

## 2.2.0 (2018-10-29)

### New Feature
### New Features

- Always request data in the user's locale ([#10862](https://github.com/WordPress/gutenberg/pull/10862)).

## 2.1.0 (2018-10-22)

### New Feature
### New Features

- Support `per_page=-1` paginated requests.

## 2.0.0 (2018-09-05)

### Breaking Change
### Breaking Changes

- Change how required built-ins are polyfilled with Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)). If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods.
12 changes: 6 additions & 6 deletions packages/autop/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,31 +141,31 @@

## 2.7.0 (2020-04-15)

### New feature
### New Features

- Include TypeScript type declarations ([#20669](https://github.com/WordPress/gutenberg/pull/20669))

## 2.3.0 (2019-05-21)

### Bug Fix
### Bug Fixes

- `removep` will correctly preserve multi-line paragraph tags where attributes are present.

## 2.1.0 (2019-03-06)

### Bug Fix
### Bug Fixes

- `autop` correctly matches whitespace preceding and following block-level elements.

## 2.0.0 (2018-09-05)

### Breaking Change
### Breaking Changes

- Change how required built-ins are polyfilled with Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)). If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods.

## 1.1.0 (2018-07-12)

### New Feature
### New Features

- Updated build to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))

Expand All @@ -175,6 +175,6 @@

## 1.0.6 (2018-05-08)

### Polish
### Internal

- Documentation: Fix API method typo for `removep`. ([#120](https://github.com/WordPress/packages/pull/120))
10 changes: 5 additions & 5 deletions packages/babel-plugin-import-jsx-pragma/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@

## 4.0.0 (2022-08-24)

### Breaking Change
### Breaking Changes

- Increase the minimum Node.js version to 14 ([#43141](https://github.com/WordPress/gutenberg/pull/43141)).

Expand All @@ -106,22 +106,22 @@

## 2.2.0 (2019-05-21)

### New Feature
### New Features

- Add Fragment import handling ([#15120](https://github.com/WordPress/gutenberg/pull/15120)).

## 2.0.0 (2019-03-06)

### Breaking Change
### Breaking Changes

- Stop using Babel transpilation internally and set node 8 as a minimal version required ([#13540](https://github.com/WordPress/gutenberg/pull/13540)).

### Enhancement
### Enhancements

- Plugin skips now adding import JSX pragma when the scope variable is defined for all JSX elements ([#13809](https://github.com/WordPress/gutenberg/pull/13809)).

## 1.1.0 (2018-09-05)

### New Feature
### New Features

- Plugin updated to work with the stable version of Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)).
12 changes: 6 additions & 6 deletions packages/babel-plugin-makepot/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@

## 5.1.0 (2022-09-13)

### Bug Fix
### Bug Fixes

- Makepot: Fix translations object handling ([#43797](https://github.com/WordPress/gutenberg/pull/43797)).

## 5.0.0 (2022-08-24)

### Breaking Change
### Breaking Changes

- Increase the minimum Node.js version to 14 ([#43141](https://github.com/WordPress/gutenberg/pull/43141)).

Expand All @@ -116,20 +116,20 @@

## 2.2.0 (2019-03-06)

### Bug Fix
### Bug Fixes

- Fixed Babel plugin for POT file generation to properly handle plural numbers specified in the passed header. ([#13577](https://github.com/WordPress/gutenberg/pull/13577))
- Fix extracted translator comments to be written as prefixed by `#.` ([#9440](https://github.com/WordPress/gutenberg/pull/9440))

## 2.1.0 (2018-09-05)

### New Feature
### New Features

- Plugin updated to work with the stable version of Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)).

## 2.0.0 (2018-07-12)

### Breaking Change
### Breaking Changes

- Updated code to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))

Expand All @@ -139,6 +139,6 @@

## 1.0.1 (2018-05-18)

### Polish
### Internal

- Fix: Standardized `package.json` format ([#119](https://github.com/WordPress/packages/pull/119))
24 changes: 12 additions & 12 deletions packages/babel-preset-default/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

- The bundled `browserslist` dependency has been updated from requiring `^4.21.9` to requiring `^4.21.10` ([#54657](https://github.com/WordPress/gutenberg/pull/54657)).

## Enhancements
### Enhancements

- Use `react` as the default scope variable for JSX pragma instead of `@wordpress/element`.

Expand All @@ -69,7 +69,7 @@

## 7.19.0 (2023-06-07)

### Enhancement
### Enhancements

- Enable the `bugfixes` option in `@babel/preset-env` to remove unneeded transpilation ([#50994](https://github.com/WordPress/gutenberg/pull/50994)).

Expand All @@ -83,7 +83,7 @@

## 7.14.0 (2023-03-29)

### Enhancement
### Enhancements

- Exclude IE-only `setImmediate`/`clearImmediate` from list of polyfills.

Expand Down Expand Up @@ -113,7 +113,7 @@

## 7.0.0 (2022-08-24)

### Breaking Change
### Breaking Changes

- Increase the minimum Node.js version to 14 ([#43141](https://github.com/WordPress/gutenberg/pull/43141)).

Expand All @@ -132,7 +132,7 @@

## 6.2.0 (2021-05-31)

### New Feature
### New Features

- New `build/polyfill.js` (minified version – `build/polyfill.min.js`) file is available that polyfills ECMAScript features missing in the [browsers supported](https://make.wordpress.org/core/handbook/best-practices/browser-support/) by the WordPress project. It's a drop-in replacement for the deprecated `@babel/polyfill` package ([#31279](https://github.com/WordPress/gutenberg/pull/31279)).

Expand Down Expand Up @@ -195,7 +195,7 @@

## 4.10.0 (2020-02-04)

### New Feature
### New Features

- The bundled `@babel/core` dependency has been updated from requiring `^7.4.4` to requiring `^7.8.3`. All other Babel plugins were updated to the latest version. `@babel/preset-env` has now ESMAScript 2020 support enabled by default (see [Highlights](https://babeljs.io/blog/2020/01/11/7.8.0#highlights)).

Expand Down Expand Up @@ -226,25 +226,25 @@
- Removed `babel-core` dependency acting as Babel 7 bridge ([#13922](https://github.com/WordPress/gutenberg/pull/13922). Ensure all references to `babel-core` are replaced with `@babel/core` .
- Preset updated to include `@wordpress/babel-plugin-import-jsx-pragma` plugin integration ([#13540](https://github.com/WordPress/gutenberg/pull/13540)). It should no longer be explicitly included in your Babel config.

### Bug Fix
### Bug Fixes

- The runtime transform no longer disables [the `regenerator` option](https://babeljs.io/docs/en/babel-plugin-transform-runtime#regenerator). This should resolve issues where a file generated using the preset would assume the presence of a `regeneratorRuntime` object in the global scope. While this is not considered a breaking change, you may be mindful to consider that with transformed output now explicitly importing the runtime regenerator, bundle sizes may increase if you do not otherwise mitigate the additional import by either (a) overriding the option in your own Babel configuration extensions or (b) redefining the resolved value of `@babel/runtime/regenerator` using a feature like [Webpack's `externals` option](https://webpack.js.org/configuration/externals/).

## 3.0.0 (2018-09-30)

### Breaking Change
### Breaking Changes

- The configured `@babel/preset-env` preset will no longer pass `useBuiltIns: 'usage'` as an option. It is therefore expected that a polyfill serve in its place, if necessary.

## 2.1.0 (2018-09-05)

### New Feature
### New Features

- Plugin updated to work with the stable version of Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)).

## 2.0.0 (2018-07-12)

### Breaking Change
### Breaking Changes

- Updated code to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))

Expand All @@ -254,12 +254,12 @@

## 1.3.0 (2018-05-22)

### New Feature
### New Features

- Added support for async generator functions ([#126](https://github.com/WordPress/packages/pull/126))

## 1.2.1 (2018-05-18)

### Polish
### Internal

- Fix: Standardized `package.json` format ([#119](https://github.com/WordPress/packages/pull/119))
4 changes: 2 additions & 2 deletions packages/base-styles/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@

## 4.0.0 (2021-09-09)

### Breaking Change
### Breaking Changes

- Remove the background-colors, foreground-colors, and gradient-colors mixins.

Expand All @@ -111,6 +111,6 @@

## 1.2.0 (2020-01-13)

### Bug Fix
### Bug Fixes

- Import `colors` into `variables` since the latter depends on the former.
Loading
Loading