Pull request #4: mclv2-mchv2-dspic33ck256mp508-an1160 release

Merge in MCU16CE/mclv2-mchv2-dspic33ck256mp508-an1160 from develop to master

* commit 'bf22498fd7c302c674c9a7c3e3f5fbd7acb2863f':
  no message
  to resolve the build error
  added xml2js
  edited to resolve build error
  remove the image
  change the image name
  changed the image format name from PNG to png
  added the MPLABX project and edited the necessary files for deployment
  Initial commit

.citd/Jenkinsfilek8s

@@ -0,0 +1,258 @@
+/*
+    Jenkins Shared Library:
+    ----------------------
+    shared-library-mcu16ce - https://bitbucket.microchip.com/scm/citd/shared-library-mcu16ce.git
+    shared-library-common - https://bitbucket.microchip.com/scm/citd/shared-library-common.git    
+*/
+@Library(['shared-library-mcu16ce@master', 'shared-library-common@master']) _
+
+pipeline {
+    agent {
+        kubernetes {
+            inheritFrom 'mclv2-mchv2-dspic33ck256mp508-an1160-github-deployment'
+            defaultContainer 'xc16-mplabx-sonar-fmpp-python'
+            yamlFile '.citd/cloudprovider.yml'
+        }
+    }
+
+    environment {
+        /*
+            Common Information
+        */
+        NOTIFICATION_EMAIL = '[email protected]'  
+        // GitHub production organization name
+        GITHUB_PRODUCTION_ORGANIZATION = "microchip-pic-avr-examples"
+
+        /*
+            GitHub Deploy Stage Information
+        */
+        //This is the BitBucket source repo URL to be deployed
+        BITBUCKET_SOURCE_URL = 'https://bitbucket.microchip.com/scm/mcu16ce/mclv2-mchv2-dspic33ck256mp508-an1160.git'  
+        //Files or folders to be excluded from deployment, if multiple files or folders use comma separator
+        DEPLOY_EXCLUDE_FOLDER_FILE_LIST = 'mchp_private,.mchp_private,sandbox,.sandbox'
+        //Branch(s) to be deployed, if multiple branches use comma separator. DEPLOY_BRANCH_LIST is the target branch of the PR.
+        DEPLOY_BRANCH_LIST = "master"
+		/*When using the main.json schema version 1.3.0 or higher, the PORTAL will first reject registration attempt when an unapproved keyword is found, but can be forced to accept. 
+		  This argument is used to provide the list of unapproved keywords (also listed in main.json) which the deployment script will force the PORTAL to accept.*/
+        UNAPPROVED_KEYWORDS_OVERRIDE_LIST="NONE"
+
+        /*
+            GitHub Page Stage Information
+            List of GitHub Page Options:
+            ----------------------------
+            1. GITHUB_PAGES_NONE         ( Branch: None, index file path: None )
+            2. GITHUB_PAGES_MASTER_ROOT  ( Branch: Master, index file path: /root )
+            3. GITHUB_PAGES_MASTER_DOCS  ( Branch: Master, index file path: /Docs ) 
+            4. GITHUB_PAGES_DEVELOP_ROOT ( Branch: Develop, index file path: /root )
+            5. GITHUB_PAGES_DEVELOP_DOCS ( Branch: Develop, index file path: /Docs )
+        */
+        GITHUB_PAGES = 'GITHUB_PAGES_NONE'    
+
+        /*
+            Project Build Stage Information
+        */
+        MPLABX_PROJECT_SOURCE = "../"
+    }
+
+    options {
+        timestamps()
+        timeout(time: 30, unit: 'MINUTES')
+    }
+
+    stages {
+        stage('Checkout') {
+            steps {
+                checkout scm
+            }
+        }
+
+        stage('project config update') {
+            steps {
+                script {                    
+                    mplabxProjectConfigUpdate(
+                        sourceFilePath: "${env.MPLABX_PROJECT_SOURCE}"
+                    )
+                }
+            }
+        }
+
+        stage('Build') {
+            steps {
+                script {  
+
+					sh("npm install -g xml2js")
+					sh("npm link xml2js")
+
+                    mplabxProjectBuild(
+                        sourceFilePath: "${env.MPLABX_PROJECT_SOURCE}"
+                    )
+               }
+            }
+        }
+
+
+		//MisraCheck code analysis 
+        stage('MISRA Check') {
+            steps {
+                script {
+				    misraCheck(
+                        sourceProjectPath: "${env.MPLABX_PROJECT_SOURCE}"
+                    )
+                }
+            }
+        }
+
+        // Validate main.json file
+		stage('Validate main.json') {            
+            steps {
+               script {                    
+                    validateMetaData(
+                        unapprovedKeywordsOverrideList: "${UNAPPROVED_KEYWORDS_OVERRIDE_LIST}"
+                    )
+                }
+            }
+        } 
+
+        stage('Doxygen files generation') {
+            when {
+                anyOf {
+                    allOf {
+                        not { changeRequest() }
+                    }
+                }
+            }
+            steps {
+                container('buildtools') {
+                    script {                    
+                        doxygen()
+                    }
+                }
+            }
+        }
+
+        // GitHub repo creation 
+        stage('GitHub Repo Creation') {
+            when {
+                anyOf {
+                    allOf {
+                        not { changeRequest() }
+			anyOf {branch 'master'; branch 'test_deploy';}
+                    }
+                }
+            }
+
+            steps {
+                script {
+                    githubRepoCreate(
+                         githubOrgName: "${env.GITHUB_PRODUCTION_ORGANIZATION}",
+                         deployBranchList: "${DEPLOY_BRANCH_LIST}"
+                    )
+                }
+            }
+        } 
+
+        // Deploying the code to GitHub 
+        stage('GitHub Deploy Source') {
+            when {
+                anyOf {
+                    allOf {
+                        not { changeRequest() }
+			anyOf {branch 'master'; branch 'test_deploy';}
+                    }
+                }
+            }
+
+            steps {
+                script {
+                    githubDeploySource(
+                        bitbucketUrl: "${env.BITBUCKET_SOURCE_URL}",
+                        deployBranchList: "${env.DEPLOY_BRANCH_LIST}",
+                        deployExcludeFileList: "${env.DEPLOY_EXCLUDE_FOLDER_FILE_LIST}",
+                        githubOrgName: "${env.GITHUB_PRODUCTION_ORGANIZATION}"
+                    )
+                }
+            }
+        }
+
+        // Creating GitHub release  
+        stage('GitHub release') {
+            when {
+                anyOf {
+                    allOf {
+                        not { changeRequest() }
+			anyOf {branch 'master'; branch 'test_deploy';}
+                    }
+                }
+            }
+
+            steps {
+               script {
+                    githubReleaseCreate(
+                        githubOrgName: "${env.GITHUB_PRODUCTION_ORGANIZATION}",
+                        deployBranchList: "${DEPLOY_BRANCH_LIST}"                        
+                    )
+                }
+            }
+        }
+
+        // Creating GitHub Page  
+        stage('GitHub Page Create') {
+            when {
+                anyOf {
+                    allOf {
+                        not { changeRequest() }
+                        anyOf {branch 'master';}
+                    }
+                }
+            }
+
+            steps {
+               script {
+                    githubPageCreate(
+                        githubPage: "${env.GITHUB_PAGES}",
+                        githubOrgName: "${env.GITHUB_PRODUCTION_ORGANIZATION}"
+                    )
+                }
+            }
+        }
+
+        //Deploying the Github content to portal
+        stage('Portal-Deploy') {
+            when {
+                allOf {
+                    not { changeRequest() }
+                    anyOf {branch 'master';}
+                }
+            }
+            steps {
+                script {
+                    portalDeploy(
+                        githubOrgName: "${env.GITHUB_PRODUCTION_ORGANIZATION}",
+						unapprovedKeywordsOverrideList: "${UNAPPROVED_KEYWORDS_OVERRIDE_LIST}"
+                    )
+                }
+            }
+        }
+  }
+
+    post {
+        success{
+            script {
+                sendMail(
+                    mailId: "${env.NOTIFICATION_EMAIL}",
+                    subject: "Successful Pipeline: ${currentBuild.fullDisplayName}",
+                    body: "Something is right with ${env.BUILD_URL}"
+                )
+            }
+        }
+        failure {
+            script {
+                sendMail(
+                    mailId: "${env.NOTIFICATION_EMAIL}",
+                    subject: "Failure Pipeline: ${currentBuild.fullDisplayName}",
+                    body: "Something is right with ${env.BUILD_URL}"
+                )
+            }
+        }
+    }
+}

.citd/cloudprovider.yml

@@ -0,0 +1,30 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: xc16-mplabx-sonar-fmpp-python
+spec:
+  containers:
+    - name: xc16-mplabx-sonar-fmpp-python
+      image:  artifacts.microchip.com:7999/microchip/citd/bundles/xc16-mplabx-sonar-fmpp-python-yarn-node:latest
+      imagePullPolicy: Always
+      command: ['cat']
+      tty: true
+      resources:
+        requests:
+          cpu: 500m
+          memory: 1500Mi
+        limits:
+          cpu: 1
+          memory: 2Gi
+    - name: buildtools
+      image: artifacts.microchip.com:7999/microchip/buildtools/doxygen:1.8.15-r0
+      imagePullPolicy: Always
+      command: ['cat']
+      tty: true
+      resources:
+        requests:
+          cpu: 500m
+          memory: 750Mi
+        limits:
+          cpu: 1
+          memory: 1Gi

.gitignore

@@ -0,0 +1,54 @@
+# .gitignore file
+#
+# Set up for Microchip/MPLAB X® development
+# 
+# Default gitignore files for code examples, only removing/ignoring usual MPLAB X® clutter
+
+# Excluding object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Excluding documentation output directories
+#docs/
+
+# Excluding any executables
+*.exe
+
+#Excluding Files/Folders Auto-Generated by Test Harness
+.generated_files/
+
+# Excluding Netbeans specific build directories and file types
+~*.*
+.generated_files/
+nbproject/build/
+nbproject/dist/
+nbproject/private/
+nbproject/disassembly/
+build/
+dist/
+private/
+disassembly/
+*.zip
+!code-templates.zip
+*.mk
+*.bash
+*.dump
+Makefile-genesis.properties
+
+# Excluding MPLAB X® Trace files
+*.log
+*.inx
+
+# KDE specific
+.directory
+
+# Misc
+.svn
+*.bak
+*.doc
+*.docx
+
+
+

.main-meta/main.json

@@ -0,0 +1,53 @@
+{
+   "metaDataVersion":"1.0.0",
+   "category":"com.microchip.ide.project",
+   "content":{
+      "metaDataVersion":"1.3.0",
+      "name":"com.microchip.mplabx.project.mclv2-mchv2-dspic33ck256mp508-an1160",
+      "version":"1.0.0",
+      "displayName":"AN1160 dspic33CK256MP508 MCLV2 MCHV ",
+      "projectName":"mclv2-mchv2-dspic33ck256mp508-an1160",
+      "shortDescription":"Sensorless BLDC Control with Back-EMF Filtering Using a Majority Function",
+      "ide":{
+         "name":"MPLABX",
+         "semverRange":">=5.50.0"
+      },
+      "compiler":{
+         "name":"XC16",
+         "semverRange":"^1.41.0"
+      },
+      "dfp":{
+         "name":"dsPIC33CK-MP_DFP",
+         "semverRange":">=1.8.224"
+      },
+	  "configurator": {
+         "name": "MCC",
+         "semverRange": ">=4.0.1"
+      },
+      "device":{
+         "metaDataVersion":"1.0.0",
+         "category":"com.microchip.portal.contentRef",
+         "content":{
+            "metaDataVersion":"1.0.0",
+            "category":"com.microchip.device",
+            "name":"dspic33CK256MP508",
+            "versionRange":"*"
+         }
+      },
+	  "peripherals":[
+		 "GPIO",
+		 "ADC",
+		 "PWM",
+		 "UART",
+		 "SCCP"
+      ],
+      "keywords":[
+         "Majority filter",
+         "MCLV2",
+		 "Motor Control",
+		 "BLDC",
+		 "sensorless",
+		 "MCHV"
+      ]
+   }
+}