@ckeditor/ckeditor5-dev-changelog 50.2.0 → 50.3.0

package/dist/index.js

@@ -644,12 +644,12 @@ async function determineNextVersion(options) {
     }
     logInfo(`○ ${chalk.cyan('Determining the new version...')}`);
     let bumpType = 'patch';
-    if (sections.minor.entries.length || sections.feature.entries.length) {
-        bumpType = 'minor';
-    }
-    if (sections.major.entries.length) {
+    if (sections.major.entries.length || sections.breaking.entries.length) {
         bumpType = 'major';
     }
+    else if (sections.minor.entries.length || sections.feature.entries.length) {
+        bumpType = 'minor';
+    }
     const areErrorsPresent = !!sections.invalid.entries.length;
     const areWarningsPresent = Object.values(sections).some(section => section.entries.some(entry => entry.data.validations && entry.data.validations.length > 0));
     const userProvidedVersion = await provideNewVersion({

package/dist/template.d.ts

@@ -8,11 +8,6 @@
 interface GenerateTemplateOptions {
     directory: string;
 }
-/**
- * Returns a filename for the template file based on the current date and git branch name.
- * The filename is formatted as `YYYYMMDDHHMMSS_{GIT_BRANCH_NAME}.md`.
- */
-export declare function getFileName(): Promise<string>;
 /**
  * Generates a template file for the changelog in the specified directory.
  */

package/dist/template.js

@@ -21,6 +21,15 @@ const TEMPLATE_FILE = path.join(import.meta.dirname, '../template/template.md');
 const DEFAULT_OPTIONS = {
     directory: CHANGESET_DIRECTORY
 };
+/**
+ * List of branch names that are usually protected.
+ */
+const PROTECTED_BRANCHES = [
+    'master',
+    'main',
+    'release',
+    'stable'
+];
 /**
  * Reads CLI arguments and turn the keys into camelcase.
  */
@@ -65,9 +74,8 @@ async function getFormattedGitBranchName() {
  * Returns a filename for the template file based on the current date and git branch name.
  * The filename is formatted as `YYYYMMDDHHMMSS_{GIT_BRANCH_NAME}.md`.
  */
-async function getFileName() {
+function getFileName(gitBranchName) {
     const date = format(new Date(), 'yyyyMMddHHmmss');
-    const gitBranchName = await getFormattedGitBranchName();
     return `${date}_${gitBranchName}.md`;
 }
 /**
@@ -75,21 +83,26 @@ async function getFileName() {
  */
 async function generateTemplate(args = getCliArguments(), retries = 5) {
     const options = normalizeOptions(args);
-    const filename = await getFileName();
+    const gitBranchName = await getFormattedGitBranchName();
+    const filename = getFileName(gitBranchName);
     const outputPath = path.resolve(options.directory, filename);
     await mkdir(options.directory, { recursive: true });
     try {
         await copyFile(TEMPLATE_FILE, outputPath, constants.COPYFILE_EXCL);
-        const indent = ' '.repeat(3);
+        const indent = ' '.repeat(2);
         const relativePath = path.relative(process.cwd(), outputPath);
-        console.log(styleText('green', '✅ The changelog file has been successfully created.'));
+        console.log(styleText('green', '◌ The changelog file has been successfully created.'));
         console.log('');
-        console.log('✍️ Please fill it with relevant information about your changes.');
-        console.log(indent + styleText('cyan', `file://${outputPath}`));
+        console.log('◌ Please fill it with relevant information about your changes.');
+        console.log(indent + styleText(['cyan', 'bold'], `file://${outputPath}`));
         console.log('');
-        console.log('📥 Once done, commit the changelog file:');
-        console.log(indent + styleText('gray', `$ git add ${relativePath}`));
-        console.log(indent + styleText('gray', '$ git commit -m "..."'));
+        console.log('◌ Once done, commit the changelog file:');
+        console.log(styleText('gray', indent + styleText('gray', `$ git add ${relativePath}`)));
+        console.log(styleText('gray', indent + styleText('gray', '$ git commit -m "..."')));
+        if (PROTECTED_BRANCHES.includes(gitBranchName)) {
+            console.log('');
+            console.warn(styleText(['red', 'bold'], 'You are on a protected branch!'), styleText('red', 'Consider creating a new branch for your changes.'));
+        }
     }
     catch (error) {
         if (retries <= 0) {
@@ -105,4 +118,4 @@ async function generateTemplate(args = getCliArguments(), retries = 5) {
     }
 }
 
-export { generateTemplate, getFileName };
+export { generateTemplate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-changelog",
-  "version": "50.2.0",
+  "version": "50.3.0",
   "description": "A CKEditor 5 development tool for handling changelogs.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -28,7 +28,7 @@
     "ckeditor5-dev-changelog-create-entry": "bin/generate-template.js"
   },
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^50.2.0",
+    "@ckeditor/ckeditor5-dev-utils": "^50.3.0",
     "chalk": "^5.0.0",
     "date-fns": "^4.0.0",
     "fs-extra": "^11.0.0",

package/template/template.md

@@ -38,6 +38,8 @@ see:
 # - {github-username}
 communityCredits:
   - 
+
+# Before committing, consider removing all comments to reduce file size and enhance readability.
 ---
 
 Required concise and meaningful summary of the change.