@@ -13,11 +13,11 @@ const { readJSONFile } = require( '../lib/utils' );
1313 * Finds the name of the current plugin release branch based on the version in
1414 * the package.json file and the latest `trunk` branch in `git`.
1515 *
16- * @param gitWorkingDirectoryPath Path to the project's working directory.
16+ * @param { string } gitWorkingDirectoryPath Path to the project's working directory.
1717 *
18- * @return Name of the plugin release branch.
18+ * @return { string } Name of the plugin release branch.
1919 */
20- async function findPluginReleaseBranchName ( gitWorkingDirectoryPath : string ) {
20+ async function findPluginReleaseBranchName ( gitWorkingDirectoryPath ) {
2121 await SimpleGit ( gitWorkingDirectoryPath )
2222 . fetch ( 'origin' , 'trunk' )
2323 . checkout ( 'trunk' ) ;
@@ -33,17 +33,17 @@ async function findPluginReleaseBranchName( gitWorkingDirectoryPath: string ) {
3333 * Calculates version bump for the packages based on the content
3434 * from the provided CHANGELOG file split into individual lines.
3535 *
36- * @param lines Changelog content split into lines.
37- * @param minimumVersionBump Minimum version bump for the package. Defaults to
38- * `patch`.
39- * @param currentVersion Current version of the package.
36+ * @param { string[] } lines Changelog content split into lines.
37+ * @param { ('patch'|'minor'|'major') } [ minimumVersionBump] Minimum version bump for the package.
38+ * Defaults to `patch`.
39+ * @param { string } [ currentVersion] Current version of the package.
4040 *
41- * @return Version bump when applicable, or null otherwise.
41+ * @return { string|null } Version bump when applicable, or null otherwise.
4242 */
4343function calculateVersionBumpFromChangelog (
44- lines : string [ ] ,
45- minimumVersionBump : 'patch' | 'minor' | 'major' = 'patch' ,
46- currentVersion : string = '1.0.0'
44+ lines ,
45+ minimumVersionBump = 'patch' ,
46+ currentVersion = '1.0.0'
4747) {
4848 let changesDetected = false ;
4949 let versionBump = null ;
0 commit comments