Merge pull request #3283 from IgniteUI/vnext

Promote production

Author: ChronosSF

.github/CONTRIBUTING.md

@@ -48,23 +48,23 @@ Open both repositories ([DocFX Site Builder](https://github.com/IgniteUI/igniteu
 # <a name='#fixing'> Fixing bugs and adding new samples</a>
 ## <a name='#bug'> Bug fixing guidelines</a>
 
-1. Depending on where the bug was found `the current version` or the `ongoing release version`, checkout a development branches from `vNext` or/and `master` branch. `vNext` is the version that is going to be used upon release (next version), and `master` is the branch with the current state (current version available on production). If the change/fix is applicable only to the ongoing release branch (`vNext`) there is no need to cherry-pick to `master` branch as the change/fix/feature will be pushed to `master` branch upon release.
+1. Depending on where the bug was found `the current version` or the `ongoing release version`, checkout a development branches from `vnext` or/and `master` branch. `vnext` is the version that is going to be used upon release (next version), and `master` is the branch with the current state (current version available on production). If the change/fix is applicable only to the ongoing release branch (`vnext`) there is no need to cherry-pick to `master` branch as the change/fix/feature will be pushed to `master` branch upon release.
 2. Run lint
 3. Pull request your changes and reference the issue. Use the enforced commit message format with applicable type, scope, etc.
 4. Don't forget to make the necessary status updates, as described in the workflow section.
 
-> Note: Cherry-pick to `master` branch only changes with **high priority**. There is no need to cherry-pick into `master` every bug fix/change from `vNext`> A regular mass merge PRs are going to be made from `vNext` into `master`.
+> Note: Cherry-pick to `master` branch only changes with **high priority**. There is no need to cherry-pick into `master` every bug fix/change from `vnext`> A regular mass merge PRs are going to be made from `vnext` into `master`.
 
 **Example workflow for a bug with high priority**
 The process will look like this:
 
-1.	Checkout new branch from `vNext`. For code example purposes let's say the new branch is called `fixing-bug-5423-vNext`.
-2.	Commit your changes to your `fixing-bug-5423-vNext` branch.
-3.	Push and PR to the `vNext` branch.
+1.	Checkout new branch from `vnext`. For code example purposes let's say the new branch is called `fixing-bug-5423-vnext`.
+2.	Commit your changes to your `fixing-bug-5423-vnext` branch.
+3.	Push and PR to the `vnext` branch.
 4.	Switch to the `master` branch.
 5.  Create a new branch from `master`. For code example purposes let's say the new branch is called `fixing-bug-5423-master`.
-6.  Cherry pick your commit from the `fixing-bug-5423-vNext` branch: `git cherry-pick ..`
+6.  Cherry pick your commit from the `fixing-bug-5423-vnext` branch: `git cherry-pick ..`
 7.  Push to your `fixing-bug-5423-master` branch and PR to the `master` branch.
 
 ## <a name='#new-sample'> Adding new samples guidelines </a>
-Depending on where the the new sample should be added, `the current version` or the `ongoing release version`, checkout a development branches from `vNext` or/and `master` branch. `vNext` is the version that is going to be used upon release (next version), and `master` is the branch with the current state (current version). If the new sample is applicable only to the ongoing release branch (`vNext`) there is no need to cherry-pick to `master` branch as the new sample will be pushed to `master` branch upon release.
+Depending on where the the new sample should be added, `the current version` or the `ongoing release version`, checkout a development branches from `vnext` or/and `master` branch. `vnext` is the version that is going to be used upon release (next version), and `master` is the branch with the current state (current version). If the new sample is applicable only to the ongoing release branch (`vnext`) there is no need to cherry-pick to `master` branch as the new sample will be pushed to `master` branch upon release.

.github/workflows/build-app-crm.yml

@@ -6,14 +6,14 @@ name: App CRM CI
 # events but only for the master branch
 on:
   push:
-    branches: [ master, vNext ]
+    branches: [ master, vnext ]
     paths:
       - '**'
       - '!src/**'
       - '!live-editing/**'
       - '!projects/app-lob/**'
   pull_request:
-    branches: [ master, vNext ]
+    branches: [ master, vnext ]
     paths:
       - '**'
       - '!src/**'
@@ -34,14 +34,20 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
             node-version: ${{ matrix.node-version }}
             cache: 'npm'
 
+      - name: Npm add registry
+        run: npm config set @infragistics:registry https://${{secrets.IG_SCOPE}}
+
+      - name: Npm config auth
+        run: npm config set ${{secrets.IG_SCOPE}}:_auth=${{secrets.IG_TOKEN}}
+
       - name: Install dependencies
         run: npm ci
 

.github/workflows/build-app-lob.yml

@@ -6,7 +6,7 @@ name: App LOB CI
 # events but only for the master branch
 on:
   push:
-    branches: [ master, vNext ]
+    branches: [ master, vnext ]
     paths:
       - '**'
       - '!src/**'
@@ -16,7 +16,7 @@ on:
       - 'live-editing/generators/AppDVConfigGenerators.ts'
       - '!projects/app-crm/**'
   pull_request:
-    branches: [ master, vNext ]
+    branches: [ master, vnext ]
     paths:
       - '**'
       - '!src/**'
@@ -39,14 +39,20 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
             node-version: ${{ matrix.node-version }}
             cache: 'npm'
 
+      - name: Npm add registry
+        run: npm config set @infragistics:registry https://${{secrets.IG_SCOPE}}
+
+      - name: Npm config auth
+        run: npm config set ${{secrets.IG_SCOPE}}:_auth=${{secrets.IG_TOKEN}}
+
       - name: Install dependencies
         run: npm ci
 

.github/workflows/codeql.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "master", "vNext" ]
+    branches: [ "master", "vnext" ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "master", "vNext" ]
+    branches: [ "master", "vnext" ]
   schedule:
     - cron: '37 17 * * 1'
 

.hooks/prepare-commit-msg

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+'use strict';
+
+var validate = require('./scripts/validate'),
+    fs = require('fs');
+
+var options = {
+    style: "default"
+};
+
+var text = fs.readFileSync(process.argv[2]).toString();
+
+var errors = [];
+errors = validate(text, options, errors);
+
+if (errors.length > 0) {
+    process.stdout.write(errors[0].toString());
+    process.exitCode = 1;
+}

.hooks/scripts/common.js

@@ -0,0 +1,44 @@
+'use strict';
+
+module.exports = {
+    matchType: (types, line) => {
+        return types.some(function(type) {
+            if (line.startsWith(type)) {
+                return true;
+            }
+
+            return false;
+        });
+    },
+
+    errorFactory: (prefix, message, additionalParams) => {
+        var result = '';
+        if (prefix) {
+            result = prefix;
+        }
+
+        result += message;
+
+        if (additionalParams) {
+            result += additionalParams;
+        }
+        
+        return result;
+    },
+
+    errorMessages: {
+        MESSAGE_SHOULD_START_WITH_TYPE: 'Message should start with one of the following types:\n',
+        NEED_OPENING_PARENTHESIS: 'Need an opening parenthesis right after the type: (',
+        TYPE_WAS_EMPTY: '<type> was empty, it must be one of these: \n',
+        TYPE_WAS_INVALID: '<type> was invalid, It has to be one of these:\n',
+        NEED_CLOSING_PARENTHESIS: 'Need a closing parenthesis after scope declaration: <scope>")"',
+        SCOPE_WAS_EMPTY: "<scope> cannot be empty!",
+        NEED_A_COLON: "Need a colon after the closing parenthesis: ):",
+        NEED_SPACE_AND_SUBJECT: 'Need a space and <subject> after colon: ": <subject>"',
+        SUBJECT_WAS_EMPTY: '<subject> must not be empty',
+        WRONG_REVERT_STRUCT: 'If this is a revert of a previous commit, please write:\n',
+        UNDEFINED_OF_COMMIT_MSG: 'Commit message is undefined, abort with error',
+        MSG_IS_NOT_A_STRING: 'Commit message is not a string, abort with error',
+        MSG_IS_EMPTY: 'Commit message is empty, abort with error'
+    }
+}

.hooks/scripts/templateValidators/default-style-validator.js

@@ -0,0 +1,75 @@
+'use strict';
+
+var matchType = require('../common').matchType,
+    errorFactory = require('../common').errorFactory,
+    errMessages = require('../common').errorMessages;
+
+module.exports = (lines, options, errors) => {
+    var scheme = '<type>(<scope>): <subject> <#issue|optional>';
+    var prefix = `First line must be ${scheme}\n`;
+
+    var line = lines[0];
+    if (line.startsWith('revert: ')) {
+        line = line.replace(/^revert: /, '');
+        prefix = `First line must be revert: ${scheme}\n`;
+    } else if (line.startsWith('revert')) {
+        errors.push(errorFactory(errMessages.WRONG_REVERT_STRUCT, 'revert: ' + scheme));
+        
+        return;
+    }
+
+    if (!matchType(options.types, line)) {
+        errors.push(errorFactory(prefix, errMessages.MESSAGE_SHOULD_START_WITH_TYPE, options.types.join(', ')));
+        
+        return;
+    }
+
+    if (line.indexOf('(') === -1) {
+        errors.push(errorFactory(prefix, errMessages.NEED_OPENING_PARENTHESIS));
+
+        return;
+    }
+
+    var type = line.replace(/\(.*/, '');
+    if (options.types.indexOf(type) === -1) {
+        errors.push(errorFactory(prefix, errMessages.TYPE_WAS_INVALID, options.types.join(', ')));
+
+        return;
+    }
+
+    if (line.indexOf(')') === -1) {
+        errors.push(errorFactory(prefix, errMessages.NEED_CLOSING_PARENTHESIS));
+
+        return;
+    }
+
+    var scope = line.slice(line.indexOf('(') + 1, line.indexOf(')'));
+    if (scope.length === 0) {
+        errors.push(errorFactory(prefix, errMessages.SCOPE_WAS_EMPTY));
+    }
+    
+    if (line.indexOf(type + '(' + scope + '):') === - 1) {
+        errors.push(errorFactory(prefix, errMessages.NEED_A_COLON));
+        
+        return;
+    }
+
+    var subject = line.split(':')[1];
+    if (subject === "" || !subject.startsWith(' ')) {
+        errors.push(errorFactory(prefix, errMessages.NEED_SPACE_AND_SUBJECT));
+        
+        return;
+    }
+
+    subject = subject.trim();
+
+    if (subject.length === 0) {
+        errors.push(errorFactory(errMessages.SUBJECT_WAS_EMPTY));
+        
+        return;
+    }
+
+    if (subject.length < options.subjectLimits) {
+        errors.push(`<subject> should contains at least ${options.subjectLimits} characters`);
+    }
+}

.hooks/scripts/templates/default.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var path = require('path');
+
+var defaults = {
+    default: {
+        style: 'default',
+        subjectLimits: 15,
+        lineLimits: {
+            firstLine: 80,
+            otherLine: 80,
+        },
+        issuePattern: '(#)[0-9]+',
+        typesWithMandatoryIssue: [],
+        guidelinesUrl: 'https://bit.ly/angular-guidelines',
+        types: [
+            'feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'build', 'ci', 'revert'
+        ],
+    },
+    oldMessagePath: path.join('.git', 'COMMIT_EDITMSG_OLD')
+}
+
+module.exports = defaults;

.hooks/scripts/utils/issue-validator.js

@@ -0,0 +1,33 @@
+'use strict';
+
+var matchType = require('../common').matchType,
+    errorFactory = require('../common').errorFactory;
+
+module.exports = (lines, options, errors) => {
+    var ticket = new RegExp(options.issuePattern);
+    var whetherIssueIsMandatory = false,
+        wheterMatchAnyIssueRef = false;
+
+
+    if (matchType(options.typesWithMandatoryIssue, lines[0])) {
+        whetherIssueIsMandatory = true;
+    }
+
+    lines.forEach((line) => {
+        line = line.trim();
+        if (line === "") {
+            return;
+        }
+
+        if (ticket.test(line)) {
+            wheterMatchAnyIssueRef = true;
+            return;
+        }
+    });
+
+    if (whetherIssueIsMandatory && !wheterMatchAnyIssueRef) {
+        errors.push(errorFactory(
+            `The issue reference for (${options.typesWithMandatoryIssue.join(', ')}) types is mandatory!\n`,
+            "Please add at least one related issue. E.g: Closes #31, Closes #45"));
+    }
+}

.hooks/scripts/utils/line-limits.js

@@ -0,0 +1,22 @@
+'use strict';
+
+module.exports = (lines, options, errors) => {
+    var limits = options.lineLimits;
+    lines.forEach((line, index) => {
+        line = line.trim();
+        if (index === 0) {
+            if (line.length === 0) {
+                errors.push('First line of commit message must not be empty!');
+            } else if (line.length > limits.firstLine) {
+                errors.push(`First line of commit message must be no logner than ${limits.firstLine} characters!`);
+            }
+        } else if (index === 1 && line.length > 0) {
+            errors.push('Second line must be always empty!');
+        } else if (line.length > limits.otherLine) {
+            errors.push(
+                `Commit message line ${index + 1} is too long: ${line.length}, only ${limits.otherLine} are allowed.
+                The line is: ${line.substring(0, 20)} [...]!`
+            );
+        }
+    });
+}