Include CHANGELOG.md in published releases again by octogonz · Pull Request #4851 · microsoft/rushstack

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) · 2024-07-25T03:17:07Z

Sometime in March 2022, the CHANGELOG.md file stopped being included in any NPM packages released by Rush Stack.

It was caused by a PNPM upgrade at some point, reflecting a decision made by NPM v7.12.0:

PR npm/cli#3200

99ff40dffnpm-packlist@2.2.0:
- feat(npmignore): Do not force include history, changelogs, notice

The fix

Update the .npmignore template for all projects to explicitly include CHANGELOG.md. I've also included CHANGELOG.json since it was included before and might be useful.

CC Cheng Liu (@chengcyber)

…packages after NPM 7.12.0 / npm-packlist@2.2.0

Pete Gonzalez (octogonz) · 2024-07-25T03:44:31Z

Corresponding TSDoc PR: microsoft/tsdoc#420

…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) · 2024-07-25T04:15:05Z

Methodology in case we need it again:

1. Delete the comment that was outside the template block

Search and delete: # (Add your project-specific overrides here)

2. Delete patterns moved to the template

Search and delete: !heft-plugin.json and !rush-plugin-manifest.json

3. Update the template:

Search for: ([\r\n]|.)+LINE[\r\n\s]+#[- ]+

Replace with:

# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
# Ignore all files by default, to avoid accidentally publishing unintended files.
*
# Use negative patterns to bring back the specific things we want to publish.
!/bin/**
!/lib/**
!/lib-*/**
!/dist/**
!CHANGELOG.md
!CHANGELOG.json
!heft-plugin.json
!rush-plugin-manifest.json
!ThirdPartyNotice.txt
# Ignore certain patterns that should not get published.
/dist/*.stats.*
/lib/**/test/
/lib-*/**/test/
*.test.js
# NOTE: These don't need to be specified, because NPM includes them automatically.
#
# package.json
# README.md
# LICENSE
# ---------------------------------------------------------------------------
# DO NOT MODIFY ABOVE THIS LINE! Add any project-specific overrides below.
# ---------------------------------------------------------------------------

4. Remove blank lines introduced by deletion

Search for \r?\n\r?\n\r?\n\r?
Replace with \n

Pete Gonzalez (octogonz) added 2 commits July 24, 2024 19:58

Fix a problem where CHANGELOG.md was no longer included in published …
61e8750
…packages after NPM 7.12.0 / npm-packlist@2.2.0

rush change
4dd91bb

Pete Gonzalez (octogonz) requested review from Daniel (D4N14L), Sean Larkin (TheLarkInn), Apostolis Haitalis (apostolisms), David Michon (dmichon-msft) and Ian Clanton-Thuon (iclanton) as code owners July 25, 2024 03:17

Pete Gonzalez (octogonz) added 2 commits July 24, 2024 20:33

Move "!heft-plugin.json" into the template
3004635

Remove redundant override
90eb89f

Pete Gonzalez (octogonz) mentioned this pull request Jul 25, 2024
Include CHANGELOG.md in published releases again microsoft/tsdoc#420
Merged

Pete Gonzalez (octogonz) mentioned this pull request Jul 25, 2024
Include CHANGELOG.md in published releases tiktok/sparo#82
Merged

Move "!rush-plugin-manifest.json" into the template
06e9af3

Pete Gonzalez (octogonz) added a commit to tiktok/rush-plugins that referenced this pull request Jul 25, 2024
Fix an issue where CHANGELOG.md was not included in published package…
e43e691
…s by syncing up with microsoft/rushstack#4851

Pete Gonzalez (octogonz) mentioned this pull request Jul 25, 2024
Include CHANGELOG.md in published releases tiktok/rush-plugins#17
Merged

Ian Clanton-Thuon (iclanton) approved these changes Jul 25, 2024
View reviewed changes

Pete Gonzalez (octogonz) merged commit c07320d into mainJul 26, 2024

Pete Gonzalez (octogonz) deleted the octogonz/missing-changelog branch July 26, 2024 17:33