Merge pull request #48 from xmos/develop

Release v4.3.0 on master

Author: shuchitak

.github/ISSUE_TEMPLATE/application-note-not-compliant.md

@@ -1,6 +1,12 @@
 lib_xassert change log
 ======================
 
+4.3.0
+-----
+
+  * CHANGED: Build examples and tests using XCommon CMake instead of XCommon
+  * CHANGED: Run tests using pytest
+
 4.2.0
 -----
 

.github/ISSUE_TEMPLATE/example-not-compliant.md

@@ -1,49 +1,83 @@
-@Library('xmos_jenkins_shared_library@v0.18.0') _
+@Library('xmos_jenkins_shared_library@v0.34.0') _
 
 getApproval()
 
 pipeline {
-  agent {
-    label 'x86_64&&macOS'
-  }
+  agent none
   environment {
     REPO = 'lib_xassert'
-    VIEW = getViewName(REPO)
   }
   options {
+    buildDiscarder(xmosDiscardBuildSettings())
     skipDefaultCheckout()
+    timestamps()
+  }
+  parameters {
+    string(
+      name: 'TOOLS_VERSION',
+      defaultValue: '15.3.0',
+      description: 'The XTC tools version'
+    )
+    string(
+      name: 'XMOSDOC_VERSION',
+      defaultValue: 'v6.1.0',
+      description: 'The xmosdoc version')
   }
   stages {
-    stage('Get view') {
-      steps {
-        xcorePrepareSandbox("${VIEW}", "${REPO}")
-      }
-    }
-    stage('Library checks') {
-      steps {
-        xcoreLibraryChecks("${REPO}")
+    stage('Build and test') {
+      agent {
+        label 'documentation && linux && x86_64'
       }
-    }
-    stage('Tests') {
-      steps {
-        runXmostest("${REPO}", 'tests')
-      }
-    }
-    stage('Build docs') {
-      steps {
-        runXdoc("${REPO}/${REPO}/doc")
+      stages {
+        stage('Build examples') {
+          steps {
+            println "Stage running on ${env.NODE_NAME}"
 
-        // Archive all the generated .pdf docs
-        archiveArtifacts artifacts: "${REPO}/**/pdf/*.pdf", fingerprint: true, allowEmptyArchive: true
-      }
-    }
-  }
-  post {
-    success {
-      updateViewfiles()
-    }
-    cleanup {
-      xcoreCleanSandbox()
-    }
+            dir("${REPO}") {
+              checkout scm
+
+              dir("examples") {
+                withTools(params.TOOLS_VERSION) {
+                  sh 'cmake -G "Unix Makefiles" -B build'
+                  sh 'xmake -C build -j 8'
+                }
+              }
+            } // dir("${REPO}")
+          } // steps
+        }  // stage('Build examples')
+
+        stage('Library Checks') {
+          steps {
+            runLibraryChecks("${WORKSPACE}/${REPO}", "v2.0.1")
+          } // steps
+        } // stage('Library Checks')
+
+        stage('Build Documentation') {
+          steps {
+            dir("${REPO}") {
+              buildDocs()
+            } // dir("${REPO}")
+          } // steps
+        } // stage('Build Documentation')
+
+        stage('Simulator tests') {
+          steps {
+            dir("${REPO}") {
+              withTools(params.TOOLS_VERSION) {
+                createVenv(reqFile: "tests/requirements.txt")
+                withVenv {
+                  dir("tests") {
+                    sh 'cmake -G "Unix Makefiles" -B build'
+                    sh 'xmake -C build -j 8'
+                    sh "pytest -n auto --junitxml=pytest_result.xml"
+                  }
+                }
+              }
+            }
+          }
+        } // stage('Simulator tests')
+
+      } // stages
+    }  // stage('Build and test')
   }
 }

.github/ISSUE_TEMPLATE/missing-application-note.md

@@ -1,8 +1,21 @@
-Lightweight assertions library
-==============================
 
+:orphan:
+
+###########################################
+lib_xassert: Lightweight Assertions Library
+###########################################
+
+:vendor: XMOS
+:version: 4.3.0
+:scope: General Use
+:description: Lightweight assertions library
+:category: General Purpose
+:keywords: debugging, logging
+:devices: xcore.ai, xcore-200
+
+********
 Overview
---------
+********
 
 This library provides a lightweight and flexible replacement for the
 standard C header ``assert.h``.
@@ -11,14 +24,42 @@ The assertions in this library can be be enabled/disabled
 and configured as to how much information they show. This
 configuration can be per "xassert unit" (i.e. for sets of files).
 
+********
 Features
-........
+********
+
+Key features of the various components in this repository are as follows
+
+  - Low memory usage
+
+  - Ability to enable or disable various features via compile time defines
+
+
+************
+Known Issues
+************
+  * None
+
+**************
+Required Tools
+**************
+
+  * XMOS XTC Tools: 15.3.0
+
+*********************************
+Required Libraries (dependencies)
+*********************************
+
+  * None
+
+*************************
+Related Application Notes
+*************************
 
-  * Low memory usage
-  * Ability to enable or disable various features via compile time defines
+  * None
 
-Software version and dependencies
-.................................
+*******
+Support
+*******
 
-The CHANGELOG contains information about the current and previous versions.
-For a list of direct dependencies, look for DEPENDENT_MODULES in lib_xassert/module_build_info.
+This package is supported by XMOS Ltd. Issues can be raised against the software at www.xmos.com/support