Merge pull request #433 from mikeller/add_debug_release

mikeller · web-flow · commit 0da036a4cdde · 2020-03-22T18:56:11.000+13:00
Added 'debug-release' gulp target, and made the Azure build default to it.
diff --git a/assets/windows/installer.nsi b/assets/windows/installer.nsi
@@ -8,9 +8,11 @@
 # ${VERSION} - Version to generate (x.y.z)
 # ${PLATFORM} - Platform to generate (win32 or win64)
 # ${DEST_FOLDER} - Destination folder for the installer files
+# ${SOURCE_FOLDER} - Source folder for the application files
+￼
 
 # Some definitions
-!define SOURCE_FILES          "..\..\apps\betaflight-blackbox-explorer\${PLATFORM}\*"
+!define SOURCE_FILES          "..\..\${SOURCE_FOLDER}\betaflight-blackbox-explorer\${PLATFORM}\*"
 !define APP_NAME              "Betaflight Blackbox Explorer"
 !define COMPANY_NAME          "Betaflight Team"
 !define GROUP_NAME            "Betaflight"
@@ -218,4 +220,4 @@ Section "Uninstall"
 	${unregisterExtension} "${EXT1}" "${EXT1_NAME}"
 	${unregisterExtension} "${EXT2}" "${EXT2_NAME}"
 
-SectionEnd
+SectionEnd
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -11,6 +11,17 @@
 #     "owner" - The owner of the repository to release to e.g. betaflight
 #     "repoName" - The name of the repository to release to e.g. blackbox-log-viewer-nightlies
 
+variables:
+  owner: betaflight
+  repoName: blackbox-log-viewer-nightlies
+  debugReleaseNotes: This is a nightly build off the tip of 'master'. It may be unstable and result in corrupted configurations or data loss. **Use only for testing.**
+  releaseNotes: This is a release build. It does not contain the debug console.
+
+parameters:
+  - name: releaseBuild
+    type: boolean
+    default: false
+
 name: $(Date:yyyyMMdd).$(BuildID)
 
 trigger:
@@ -35,8 +46,12 @@ stages:
       displayName: 'Install Node.js 10.16.3'
     - script: yarn install
       displayName: 'Run yarn install'
-    - script: yarn release --win32
-      displayName: 'Run gulp release'
+    - script: yarn gulp release --win32
+      displayName: 'Run yarn release for win32'
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', true))
+    - script: yarn gulp debug-release --win32
+      displayName: 'Run yarn debug release for win32'
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', false))
     - powershell: Set-Content -Path '$(System.DefaultWorkingDirectory)/release/log.txt' -Value $env:BUILD_SOURCEVERSIONMESSAGE
 
     - task: PublishPipelineArtifact@1
@@ -59,8 +74,11 @@ stages:
     - script: yarn install
       displayName: 'Run yarn install'
     - script: yarn gulp release --osx64
-      displayName: 'Run release'
-
+      displayName: 'Run yarn release for OSX'
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', true))
+    - script: yarn gulp debug-release --osx64
+      displayName: 'Run yarn debug release for OSX'
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', false))
     - task: PublishPipelineArtifact@1
       displayName: 'Publish MacOS release'
       inputs:
@@ -78,8 +96,12 @@ stages:
       displayName: 'Install Node.js 10.16.3'
     - script: yarn install
       displayName: 'Run yarn install'
-    - script: yarn release --linux64
-      displayName: 'Run gulp release'
+    - script: yarn gulp release --linux64
+      displayName: 'Run yarn release for linux'
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', true))
+    - script: yarn gulp debug-release --linux64
+      displayName: 'Run yarn debug-release for linux'
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', false))
     - script: cd $(System.DefaultWorkingDirectory)/release; find -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
       displayName: 'Clean release folders'
 
@@ -99,15 +121,19 @@ stages:
       inputs:
         buildType: 'current'
         targetPath: '$(Pipeline.Workspace)'
-    - powershell: Write-Output ("##vso[task.setvariable variable=releaseNotes;]$(gc $(Pipeline.Workspace)/blackbox-log-viewer-windows/log.txt)")
-
+    - powershell: Write-Output ("##vso[task.setvariable variable=changelog;]$(gc $(Pipeline.Workspace)/betaflight-configurator-windows/log.txt)")
+    - powershell: Write-Output ("##vso[task.setvariable variable=releaseNotes;]$(debugReleaseNotes)")
+      condition: and(succeeded(), eq('${{ parameters.releaseBuild }}', false))
     - task: GitHubReleasePublish@1
       inputs:
         githubEndpoint: '$(endpoint)'
         manuallySetRepository: true
         githubOwner: '$(owner)'
         githubRepositoryName: '$(repoName)'
-        githubReleaseNotes: '$(releaseNotes)'
+        githubReleaseNotes: |+
+          $(releaseNotes)
+
+          $(changelog)
         githubReleaseDraft: false
         githubReleasePrerelease: false
         githubIgnoreAssets: false
diff --git a/gulpfile.js b/gulpfile.js
@@ -56,18 +56,23 @@ gulp.task('clean-release', clean_release);
 
 gulp.task('clean-cache', clean_cache);
 
-var distRebuild = gulp.series(clean_dist, dist);
+const distRebuild = gulp.series(clean_dist, dist);
 gulp.task('dist', distRebuild);
 
-var appsBuild = gulp.series(gulp.parallel(clean_apps, distRebuild), apps, gulp.parallel(listPostBuildTasks(APPS_DIR)));
+const appsBuild = gulp.series(gulp.parallel(clean_apps, distRebuild), apps, gulp.parallel(listPostBuildTasks(APPS_DIR)));
 gulp.task('apps', appsBuild);
 
-var debugBuild = gulp.series(dist, debug, gulp.parallel(listPostBuildTasks(DEBUG_DIR)), start_debug)
+const debugAppsBuild = gulp.series(gulp.parallel(clean_debug, distRebuild), debug, gulp.parallel(listPostBuildTasks(DEBUG_DIR)));
+
+const debugBuild = gulp.series(dist, debug, gulp.parallel(listPostBuildTasks(DEBUG_DIR)), start_debug);
 gulp.task('debug', debugBuild);
 
-var releaseBuild = gulp.series(gulp.parallel(clean_release, appsBuild), gulp.parallel(listReleaseTasks()));
+const releaseBuild = gulp.series(gulp.parallel(clean_release, appsBuild), gulp.parallel(listReleaseTasks(APPS_DIR)));
 gulp.task('release', releaseBuild);
 
+const debugReleaseBuild = gulp.series(gulp.parallel(clean_release, debugAppsBuild), gulp.parallel(listReleaseTasks(DEBUG_DIR)));
+gulp.task('debug-release', debugReleaseBuild);
+
 gulp.task('default', debugBuild);
 
 // -----------------
@@ -432,7 +437,11 @@ function start_debug(done) {
 }
 
 // Create installer package for windows platforms
-function release_win(arch, done) {
+function release_win(arch, appDirectory, done) {
+    if (!commandExistsSync('makensis')) {
+        console.warn(`makensis command not found, not generating win package for ${arch}`);
+        done();
+    }
 
     // The makensis does not generate the folder correctly, manually
     createDirIfNotExists(RELEASE_DIR);
@@ -443,7 +452,8 @@ function release_win(arch, done) {
             define: {
                 'VERSION': pkg.version,
                 'PLATFORM': arch,
-                'DEST_FOLDER': RELEASE_DIR
+                'DEST_FOLDER': RELEASE_DIR,
+                'SOURCE_FOLDER': appDirectory,
             }
         }
 
@@ -457,10 +467,10 @@ function release_win(arch, done) {
 }
 
 // Create distribution package (zip) for windows and linux platforms
-function release_zip(arch) {
-    var src = path.join(APPS_DIR, pkg.name, arch, '**');
-    var output = getReleaseFilename(arch, 'zip');
-    var base = path.join(APPS_DIR, pkg.name, arch);
+function release_zip(arch, appDirectory) {
+    const src = path.join(appDirectory, pkg.name, arch, '**');
+    const output = getReleaseFilename(arch, 'zip');
+    const base = path.join(appDirectory, pkg.name, arch);
 
     return compressFiles(src, base, output, 'Betaflight Blackbox Explorer');
 }
@@ -482,7 +492,7 @@ function compressFiles(srcPath, basePath, outputFile, zipFolder) {
                .pipe(gulp.dest(RELEASE_DIR));
 }
 
-function release_deb(arch, done) {
+function release_deb(arch, appDirectory, done) {
     // Check if dpkg-deb exists
     if (!commandExistsSync('dpkg-deb')) {
         console.warn('dpkg-deb command not found, not generating deb package for ' + arch);
@@ -504,7 +514,7 @@ function release_deb(arch, done) {
         break;
     }
 
-    return gulp.src([path.join(APPS_DIR, pkg.name, arch, '*')])
+    return gulp.src([path.join(appDirectory, pkg.name, arch, '*')])
         .pipe(deb({
              package: pkg.name,
              version: pkg.version,
@@ -529,12 +539,12 @@ function release_deb(arch, done) {
     }));
 }
 
-function release_rpm(arch, done) {
+function release_rpm(arch, appDirectory, done) {
 
     // Check if dpkg-deb exists
     if (!commandExistsSync('rpmbuild')) {
         console.warn('rpmbuild command not found, not generating rpm package for ' + arch);
-        return done();
+        done();
     }
 
     // The buildRpm does not generate the folder correctly, manually
@@ -550,7 +560,7 @@ function release_rpm(arch, done) {
              requires: 'libgconf-2-4',
              prefix: '/opt',
              files:
-                 [ { cwd: path.join(APPS_DIR, pkg.name, arch),
+                 [ { cwd: path.join(appDirectory, pkg.name, arch),
                      src: '*',
                      dest: `${LINUX_INSTALL_DIR}/${pkg.name}` } ],
              postInstallScript: [`cp ${LINUX_INSTALL_DIR}/${pkg.name}/mime/${pkg.name}.xml /usr/share/mime/packages/`, 'update-mime-database /usr/share/mime',
@@ -575,7 +585,7 @@ function release_rpm(arch, done) {
 }
 
 // Create distribution package for macOS platform
-function release_osx64() {
+function release_osx64(appDirectory) {
     var appdmg = require('gulp-appdmg');
 
     // The appdmg does not generate the folder correctly, manually
@@ -585,7 +595,7 @@ function release_osx64() {
     return gulp.src(['.'])
         .pipe(appdmg({
             target: path.join(RELEASE_DIR, getReleaseFilename('macOS', 'dmg')),
-            basepath: path.join(APPS_DIR, pkg.name, 'osx64'),
+            basepath: path.join(appDirectory, pkg.name, 'osx64'),
             specification: {
                 title: 'BF Blackbox Explorer', // <= volume name; should be smaller than 27 chars.
                 contents: [
@@ -640,7 +650,7 @@ function createDirIfNotExists(dir) {
 }
 
 // Create a list of the gulp tasks to execute for release
-function listReleaseTasks(done) {
+function listReleaseTasks(appDirectory) {
 
     createDirIfNotExists(RELEASE_DIR);
 
@@ -653,27 +663,45 @@ function listReleaseTasks(done) {
     }
 
     if (platforms.indexOf('linux64') !== -1) {
-        releaseTasks.push(function release_linux64_zip(){ return release_zip('linux64') });
-        releaseTasks.push(function release_linux64_deb(done){ return release_deb('linux64', done) });
-        releaseTasks.push(function release_linux64_rpm(done){ return release_rpm('linux64', done) });
+        releaseTasks.push(function release_linux64_zip(){
+            return release_zip('linux64', appDirectory);
+        });
+        releaseTasks.push(function release_linux64_deb(done){
+            return release_deb('linux64', appDirectory, done);
+        });
+        releaseTasks.push(function release_linux64_rpm(done){
+            return release_rpm('linux64', appDirectory, done);
+        });
     }
 
     if (platforms.indexOf('linux32') !== -1) {
-        releaseTasks.push(function release_linux32_zip(){ return release_zip('linux32') });
-        releaseTasks.push(function release_linux32_deb(done){ return release_deb('linux32', done) });
-        releaseTasks.push(function release_linux32_rpm(done){ return release_rpm('linux32', done) });
+        releaseTasks.push(function release_linux32_zip(){
+            return release_zip('linux32', appDirectory);
+        });
+        releaseTasks.push(function release_linux32_deb(done){
+            return release_deb('linux32', appDirectory, done);
+        });
+        releaseTasks.push(function release_linux32_rpm(done){
+            return release_rpm('linux32', appDirectory, done);
+        });
     }
 
     if (platforms.indexOf('osx64') !== -1) {
-        releaseTasks.push(release_osx64);
+        releaseTasks.push(function () {
+            return release_osx64(appDirectory);
+        });
     }
 
     if (platforms.indexOf('win32') !== -1) {
-        releaseTasks.push(function release_win32(done){ return release_win('win32', done) });
+        releaseTasks.push(function release_win32(done) {
+            return release_win('win32', appDirectory, done);
+        });
     }
 
     if (platforms.indexOf('win64') !== -1) {
-        releaseTasks.push(function release_win64(done){ return release_win('win64', done) });
+        releaseTasks.push(function release_win64(done) {
+            return release_win('win64', appDirectory, done);
+        });
     }
 
     return releaseTasks;
