Init Changelog Sync Script #5776

spacesailor24 · 2023-01-25T02:40:14Z

Supersedes #5769 and closes #5451

What This PR Does

This PR introduces the script-pseudo-package changelog (found under scripts/changelog). It currently supports the following commands:

sync: Takes the changes from the ## [Unreleased] sections of each package's CHANGELOG.md and adds it to the root CHANGELOG.md

The following commands will add an entry to a specific package's CHANGELOG.md under the provided header:

added
changed
deprecated
removed
fixed
security

Any other command will display the help table;

Invalid command, please refer to below table for expected commands:
┌─────────┬──────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────┬────────────────────────────────────────────────────────────┬───────────────────────────────┐
│ (index) │     name     │                                             description                                             │              arguments              │                          example                           │        commandFunction        │
├─────────┼──────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────┼────────────────────────────────────────────────────────────┼───────────────────────────────┤
│    0    │    'sync'    │ 'Checks CHANGELOG.md for each package in ./packages/ for entries not included in root CHANGELOG.md' │                 []                  │                           'sync'                           │  [Function: syncChangelogs]   │
│    1    │   'added'    │               "Adds changelogEntry to packageName's CHANGELOG.md under Added header"                │ [ 'packageName', 'changelogEntry' ] │   'yarn changelog added [packageName] [changelogEntry]'    │ [Function: addChangelogEntry] │
│    2    │  'changed'   │              "Adds changelogEntry to packageName's CHANGELOG.md under Changed header"               │ [ 'packageName', 'changelogEntry' ] │  'yarn changelog changed [packageName] [changelogEntry]'   │ [Function: addChangelogEntry] │
│    3    │ 'deprecated' │             "Adds changelogEntry to packageName's CHANGELOG.md under Deprecated header"             │ [ 'packageName', 'changelogEntry' ] │ 'yarn changelog deprecated [packageName] [changelogEntry]' │ [Function: addChangelogEntry] │
│    4    │  'removed'   │              "Adds changelogEntry to packageName's CHANGELOG.md under Removed header"               │ [ 'packageName', 'changelogEntry' ] │  'yarn changelog removed [packageName] [changelogEntry]'   │ [Function: addChangelogEntry] │
│    5    │   'fixed'    │               "Adds changelogEntry to packageName's CHANGELOG.md under Fixed header"                │ [ 'packageName', 'changelogEntry' ] │   'yarn changelog fixed [packageName] [changelogEntry]'    │ [Function: addChangelogEntry] │
│    6    │  'security'  │              "Adds changelogEntry to packageName's CHANGELOG.md under Security header"              │ [ 'packageName', 'changelogEntry' ] │  'yarn changelog security [packageName] [changelogEntry]'  │ [Function: addChangelogEntry] │
└─────────┴──────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────┴────────────────────────────────────────────────────────────┴───────────────────────────────┘

Usage

To use the script, in the project root, run yarn changelog <command> <arguments> e.g.:

yarn changelog sync
yarn changelog added web3 "I added this change (#1234)"
yarn changelog removed web3 "I removed something (#1235)"

…Update format NPM script to format .ts files in scripts dir

…o wyatt/4.x/5451-refactor

spacesailor24 · 2023-01-25T02:57:40Z

CHANGELOG.md

+### Added
+
+#### web3-core
+


Ran yarn changelog sync to make this change as current 4.x CHANGELOG.md is missing these headers

spacesailor24 · 2023-01-25T02:58:25Z

fixtures/contracts/Basic.sol

-			bool
-		)
-	{
+	function getValues() public view returns (uint256, string memory, bool) {


These file changes are a result of running yarn format

spacesailor24 · 2023-01-25T02:58:40Z

fixtures/contracts/Greeter.sol

@@ -3,29 +3,29 @@
 pragma solidity ^0.8.13;

 contract Greeter {
-    uint256 counter;


These file changes are a result of running yarn format

spacesailor24 · 2023-01-25T02:59:49Z

packages/web3-core/src/web3_subscription_manager.ts

+	id,
+	sub,


This error was reported after running yarn lint:fix

spacesailor24 · 2023-01-25T03:00:13Z

packages/web3-eth-contract/test/fixtures/contracts/SampleStorageContract.sol

@@ -18,17 +18,16 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 pragma solidity ^0.8.7;

 contract SampleStorageContract {
+	uint256 uintNum;


These file changes are a result of running yarn format

spacesailor24 · 2023-01-25T03:00:50Z

packages/web3-validator/src/utils.ts

@@ -28,7 +28,7 @@ import { isAbiParameterSchema } from './validation/abi';
 import { isHexStrict } from './validation/string';
 // import { abiToJsonSchemaCases } from '../test/fixtures/abi_to_json_schema';

-export const parseBaseType = <T = typeof VALID_ETH_BASE_TYPES[number]>(
+export const parseBaseType = <T = (typeof VALID_ETH_BASE_TYPES)[number]>(


These file changes are a result of running yarn format

cloudflare-workers-and-pages · 2023-01-25T03:12:26Z

Deploying with Cloudflare Pages

Latest commit:	`bb5afb8`
Status:	✅ Deploy successful!
Preview URL:	https://94d75eff.web3-js-docs.pages.dev
Branch Preview URL:	https://wyatt-4-x-5451-refactor.web3-js-docs.pages.dev

View logs

…lattenSyncedUnreleasedEntries

…ted functions

…o wyatt/4.x/5451-refactor

github-actions · 2023-02-02T00:53:27Z

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset	Old size	New size	Diff	Diff %
Total	1.18 MB	1.18 MB	0	0.00%

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	Old size	New size	Diff %
web3.min.js	1.17 MB	1.17 MB	0.00%
../lib/accounts.d.ts	3.42 KB	3.42 KB	0.00%
../lib/types.d.ts	1.92 KB	1.92 KB	0.00%
../lib/types.d.ts.map	1.75 KB	1.75 KB	0.00%
../lib/abi.d.ts	1020 bytes	1020 bytes	0.00%
../lib/web3.d.ts	842 bytes	842 bytes	0.00%
../lib/web3.d.ts.map	693 bytes	693 bytes	0.00%
../lib/accounts.d.ts.map	528 bytes	528 bytes	0.00%
../lib/index.d.ts.map	155 bytes	155 bytes	0.00%
../lib/version.d.ts.map	140 bytes	140 bytes	0.00%
../lib/abi.d.ts.map	124 bytes	124 bytes	0.00%
../lib/version.d.ts	97 bytes	97 bytes	0.00%
../lib/index.d.ts	77 bytes	77 bytes	0.00%

Muhammad-Altabba · 2023-02-02T10:00:29Z

What This PR Does

This PR introduces the script-pseudo-package changelog (found under scripts/changelog). It currently supports the following commands:

sync: Takes the changes from the ## [Unreleased] sections of each package's CHANGELOG.md and adds it to the root CHANGELOG.md

The following commands will add an entry to a specific package's CHANGELOG.md under the provided header:

added
changed
deprecated
removed
fixed
security

Any other command will display the help table;

Invalid command, please refer to below table for expected commands:
┌─────────┬──────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────┬────────────────────────────────────────────────────────────┬───────────────────────────────┐
│ (index) │     name     │                                             description                                             │              arguments              │                          example                           │        commandFunction        │
├─────────┼──────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────┼────────────────────────────────────────────────────────────┼───────────────────────────────┤
│    0    │    'sync'    │ 'Checks CHANGELOG.md for each package in ./packages/ for entries not included in root CHANGELOG.md' │                 []                  │                           'sync'                           │  [Function: syncChangelogs]   │
│    1    │   'added'    │               "Adds changelogEntry to packageName's CHANGELOG.md under Added header"                │ [ 'packageName', 'changelogEntry' ] │   'yarn changelog added [packageName] [changelogEntry]'    │ [Function: addChangelogEntry] │
│    2    │  'changed'   │              "Adds changelogEntry to packageName's CHANGELOG.md under Changed header"               │ [ 'packageName', 'changelogEntry' ] │  'yarn changelog changed [packageName] [changelogEntry]'   │ [Function: addChangelogEntry] │
│    3    │ 'deprecated' │             "Adds changelogEntry to packageName's CHANGELOG.md under Deprecated header"             │ [ 'packageName', 'changelogEntry' ] │ 'yarn changelog deprecated [packageName] [changelogEntry]' │ [Function: addChangelogEntry] │
│    4    │  'removed'   │              "Adds changelogEntry to packageName's CHANGELOG.md under Removed header"               │ [ 'packageName', 'changelogEntry' ] │  'yarn changelog removed [packageName] [changelogEntry]'   │ [Function: addChangelogEntry] │
│    5    │   'fixed'    │               "Adds changelogEntry to packageName's CHANGELOG.md under Fixed header"                │ [ 'packageName', 'changelogEntry' ] │   'yarn changelog fixed [packageName] [changelogEntry]'    │ [Function: addChangelogEntry] │
│    6    │  'security'  │              "Adds changelogEntry to packageName's CHANGELOG.md under Security header"              │ [ 'packageName', 'changelogEntry' ] │  'yarn changelog security [packageName] [changelogEntry]'  │ [Function: addChangelogEntry] │
└─────────┴──────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────┴────────────────────────────────────────────────────────────┴───────────────────────────────┘

Usage

To use the script, in the project root, run yarn changelog <command> <arguments> e.g.:

yarn changelog sync
yarn changelog added web3 "I added this change (#1234)"
yarn changelog removed web3 "I removed something (#1235)"

Great work @spacesailor24 ,
Could you please add this description to a README.md file inside scripts/changelog. And also add a summary of the usage to the main README.md file (with a link to the README.md file inside scripts/changelog)?
Thanks,

spacesailor24 added 17 commits January 20, 2023 23:36

Init changelog NPM script. Add @types/inquirer, inquirer, and yargs. …

5a687f0

…Update format NPM script to format .ts files in scripts dir

Add cypress/.cert and *.lock to prettierignore

d3350fd

Ran yarn format

5420ab8

Bug fix and ts-expect-error reported after updating packages

7a08878

Init changelog script

5620f74

Add missing headers for 5525 addition

dcc1559

Add chalk dev dep

984b55a

Add check-sync command

fcf7f0f

Remove chalk, inquirer, and yargs dev deps

69695e7

Init changelog script refactor

751b2e8

Init changelog script tests

e2b1697

Configure mock page CHANGELOGs

b2a36f6

Make mock_root_CHANGELOG a template

77261c3

Rename mock_parsed_package_changelog

f9b1845

Rename mock_parsed_root_changelog. Add mockRootSyncedChangelog

36e0ca4

Finish writing syncChangelogs test

e4f5787

Finish writing syncChangelogs method

69e2c25

spacesailor24 added the 4.x 4.0 related label Jan 25, 2023

spacesailor24 self-assigned this Jan 25, 2023

spacesailor24 added 5 commits January 24, 2023 16:40

Merge branch '4.x' into wyatt/4.x/5451-refactor

796df0d

Replace rootChangelogPath with TestChangelogConfig.rootChangelogPath

5c9b111

Merge branch 'wyatt/4.x/5451-refactor' of github.com:web3/web3.js int…

53b14ce

…o wyatt/4.x/5451-refactor

Ran yarn changelog sync

91e337c

Revert non-related changes to package.json and yarn.lock

df58424

spacesailor24 commented Jan 25, 2023

View reviewed changes

spacesailor24 added 3 commits January 24, 2023 21:41

Break out syncChangelogs into getSyncedGroupedUnreleasedEntries and f…

ba69cad

…lattenSyncedUnreleasedEntries

Break changelog.ts into seperate files and init tests for newly expor…

33ddd76

…ted functions

Merge branch '4.x' into wyatt/4.x/5451-refactor

9ab00cd

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5451-refactor) January 26, 2023 05:52 Inactive

spacesailor24 added 5 commits January 25, 2023 22:04

Init addChangelogEntry and tests

f26c934

Name refactoring

ed815be

Merge branch 'wyatt/4.x/5451-refactor' of github.com:web3/web3.js int…

1e79dff

…o wyatt/4.x/5451-refactor

Fix bug when CHANGELOG_CONFIG path not provided

fcfe283

Merge branch '4.x' into wyatt/4.x/5451-refactor

30f19e9

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5451-refactor) January 26, 2023 08:25 Inactive

spacesailor24 marked this pull request as ready for review January 26, 2023 08:25

spacesailor24 requested review from jdevcs, avkos, luu-alex, Muhammad-Altabba and nikoulai January 26, 2023 08:26

jdevcs approved these changes Jan 26, 2023

View reviewed changes

avkos approved these changes Jan 31, 2023

View reviewed changes

nikoulai approved these changes Feb 1, 2023

View reviewed changes

Merge branch '4.x' into wyatt/4.x/5451-refactor

60f20bf

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5451-refactor) February 1, 2023 17:44 Inactive

Merge branch '4.x' into wyatt/4.x/5451-refactor

bb5afb8

github-actions bot deployed to Preview: (wyatt/4.x/5451-refactor) February 2, 2023 00:55 View deployment

spacesailor24 merged commit 8989557 into 4.x Feb 2, 2023

spacesailor24 deleted the wyatt/4.x/5451-refactor branch February 2, 2023 01:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Init Changelog Sync Script #5776

Init Changelog Sync Script #5776

spacesailor24 commented Jan 25, 2023 •

edited

Loading

spacesailor24 Jan 25, 2023

spacesailor24 Jan 25, 2023

spacesailor24 Jan 25, 2023

spacesailor24 Jan 25, 2023

spacesailor24 Jan 25, 2023

spacesailor24 Jan 25, 2023

cloudflare-workers-and-pages bot commented Jan 25, 2023 •

edited

Loading

github-actions bot commented Feb 2, 2023

Muhammad-Altabba commented Feb 2, 2023 •

edited

Loading

What This PR Does

Usage

		### Added

		#### web3-core

Init Changelog Sync Script #5776

Init Changelog Sync Script #5776

Conversation

spacesailor24 commented Jan 25, 2023 • edited Loading

What This PR Does

Usage

spacesailor24 Jan 25, 2023

Choose a reason for hiding this comment

spacesailor24 Jan 25, 2023

Choose a reason for hiding this comment

spacesailor24 Jan 25, 2023

Choose a reason for hiding this comment

spacesailor24 Jan 25, 2023

Choose a reason for hiding this comment

spacesailor24 Jan 25, 2023

Choose a reason for hiding this comment

spacesailor24 Jan 25, 2023

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented Jan 25, 2023 • edited Loading

Deploying with Cloudflare Pages

github-actions bot commented Feb 2, 2023

Bundle Stats

Muhammad-Altabba commented Feb 2, 2023 • edited Loading

What This PR Does

Usage

spacesailor24 commented Jan 25, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Jan 25, 2023 •

edited

Loading

Muhammad-Altabba commented Feb 2, 2023 •

edited

Loading