Skip to content

Commit d97031d

Browse files
Rajdeep Chandracastastrophe
authored andcommitted
chore: updated jsdoc for createGLobalChange function
1 parent ea9d931 commit d97031d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

scripts/update-global-changelog.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ const repoUrl = 'https://github.com/adobe/spectrum-web-components';
2222

2323
/**
2424
* Creates or updates the global CHANGELOG.md file based on changeset files.
25+
* This function should be run as part of the release process after changeset version
26+
* but before publishing to ensure the global changelog is updated with the latest changes.
27+
* It is automatically called by the `yarn changeset-publish` command.
2528
* @returns {Promise<void>} A promise that resolves when the changelog is updated
2629
* @throws {Error} If there's an issue with git tags or file operations
2730
*/

0 commit comments

Comments
 (0)