WIP

Author: CMCDragonkai

.gitlab-ci.yml

@@ -48,8 +48,11 @@ check:lint:
         npm run lint;
         '
   rules:
+    # Runs on feature and staging commits and ignores version commits
     - if: $CI_COMMIT_BRANCH =~ /^(?:feature.*|staging)$/ && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Manually run on commits other than master and ignore version commits
     - if: $CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH != 'master' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
       when: manual
 
@@ -59,8 +62,11 @@ check:nix-dry:
   script:
     - nix-build -v -v --dry-run ./release.nix
   rules:
+    # Runs on feature and staging commits and ignores version commits
     - if: $CI_COMMIT_BRANCH =~ /^(?:feature.*|staging)$/ && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Manually run on commits other than master and ignore version commits
     - if: $CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH != 'master' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
       when: manual
 
@@ -79,9 +85,9 @@ check:test:
       junit:
         - ./tmp/junit.xml
   rules:
-    # Run on feature branches, but not on version commits
+    # Runs on staging commits and ignores version commits
     - if: $CI_COMMIT_BRANCH =~ /^feature.*$/ && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
-    # For branches other than master and staging, manually activate, but not on version commits
+    # Manually run on commits other than master and staging and ignore version commits
     - if: $CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH !~ /^(?:master|staging)$/ && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
       when: manual
 
@@ -106,7 +112,9 @@ build:linux:
       # Only the build:linux preserves the dist
       - ./dist
   rules:
+    # Runs on staging commits and ignores version commits
     - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 build:windows:
@@ -134,7 +142,9 @@ build:windows:
     paths:
       - ./prebuilds/
   rules:
+    # Runs on staging commits and ignores version commits
     - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 build:macos:
@@ -168,7 +178,9 @@ build:macos:
     paths:
       - ./prebuilds/
   rules:
+    # Runs on staging commits and ignores version commits
     - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 build:prerelease:
@@ -211,10 +223,10 @@ build:prerelease:
   after_script:
     - rm -f ./.npmrc
   rules:
-    # Only runs on tag pipeline, and only where the tag is a prerelease version
+    # Only runs on tag pipeline where the tag is a prerelease version
     # This requires dependencies to also run on tag pipeline
-    # However release tagging comes with a release commit
-    # Dependencies must not run on the release commit
+    # However version tag comes with a version commit
+    # Dependencies must not run on the version commit
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+-.*[0-9]+$/
 
 integration:builds:
@@ -250,7 +262,9 @@ integration:builds:
     paths:
       - ./builds/
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:deployment:
@@ -260,13 +274,17 @@ integration:deployment:
   script:
     - echo 'Perform service deployment for integration testing'
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:nix:
   stage: integration
   needs:
     - integration:builds
+    - job: integration:deployment
+      optional: true
   script:
     - >
         build_application="$( \
@@ -276,13 +294,17 @@ integration:nix:
         )"
     - $build_application/bin/typescript-demo-lib
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:docker:
   stage: integration
   needs:
     - integration:builds
+    - job: integration:deployment
+      optional: true
   image: docker:20.10.11
   services:
     - docker:20.10.11-dind
@@ -294,43 +316,57 @@ integration:docker:
     - image="$(docker load --input ./builds/*docker* | cut -d' ' -f3)"
     - docker run "$image"
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:linux:
   stage: integration
   needs:
     - integration:builds
+    - job: integration:deployment
+      optional: true
   image: ubuntu:latest
   script:
     - for f in ./builds/*-linux-*; do "$f"; done
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:windows:
   stage: integration
   needs:
     - integration:builds
+    - job: integration:deployment
+      optional: true
   tags:
     - windows
   script:
     - Get-ChildItem -File ./builds/*-win-* | ForEach {& $_.FullName}
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:macos:
   stage: integration
   needs:
     - integration:builds
+    - job: integration:deployment
+      optional: true
   tags:
     - shared-macos-amd64
   image: macos-11-xcode-12
   script:
     - for f in ./builds/*-macos-x64*; do "$f"; done
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 integration:prerelease:
@@ -380,7 +416,11 @@ integration:prerelease:
         fi;
         '
   rules:
-    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Only runs on tag pipeline where the tag is a release version
+    # This requires dependencies to also run on tag pipeline
+    # However version tag comes with a version commit
+    # Dependencies must not run on the version commit
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+-.*[0-9]+$/
 
 integration:merge:
   stage: integration
@@ -397,13 +437,12 @@ integration:merge:
       optional: true
   script:
     - echo 'use gh to create and merge PR from staging to master'
+    - echo 'use github commit status to signal master to allow merge'
   rules:
-    - if: $CI_COMMIT_BRANCH == 'staging'
-
-# the expectation is that you must have merged into master from staging to trigger this
-# if you directly push to master, you corrupt this entire process
-# because this will end up acquiring it from the latest builds from the same path
-# thus we prevent master branch, direct merging into master branch
+    # Runs on staging commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'staging' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a prerelease or release version
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
 
 release:deployment:
   stage: release
@@ -413,16 +452,16 @@ release:deployment:
       ref: staging
       artifacts: true
   script:
-    - echo 'Perform service deployment for production release'
+    - echo 'Perform service deployment for production'
   rules:
-    - if: $CI_COMMIT_BRANCH == 'master'
+    # Runs on master commits and ignores version commits
+    - if: $CI_COMMIT_BRANCH == 'master' && $CI_COMMIT_TITLE !~ /^[0-9]+\.[0-9]+\.[0-9]+(?:-.*[0-9]+)?$/
+    # Runs on tag pipeline where the tag is a release version
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/
 
-# TODO: use gh to produce the final release tag and page with all binaries
-# TODO: use npm to produce the final npm erlease too
 release:distribution:
   stage: release
   needs:
-    - release:deployment
     - project: $CI_PROJECT_PATH
       job: build:linux
       ref: staging
@@ -439,18 +478,48 @@ release:distribution:
       job: integration:builds
       ref: staging
       artifacts: true
+    - job: release:deployment
+      optional: true
   # Don't interrupt publishing job
   interruptible: false
   allow_failure: true
   before_script:
     - echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ./.npmrc
   script:
+    - echo 'Publishing library & application release'
     - >
         nix-shell --run '
         npm publish --access public;
         '
+    - >
+      for d in prebuilds/*; do
+        tar \
+          --create \
+          --verbose \
+          --file="prebuilds/$(basename $d).tar" \
+          --directory=prebuilds \
+          "$(basename $d)";
+      done;
+    - >
+        nix-shell -I nixpkgs=./pkgs.nix --packages git gitAndTools.gh --run '
+        gh release \
+          create "$CI_COMMIT_TAG" \
+          prebuilds/*.tar \
+          builds/*.closure.gz \
+          builds/*-docker-* \
+          builds/*-linux-* \
+          builds/*-win-* \
+          builds/*-macos-* \
+          --title "Build-$(date -u +"%Y-%m-%dT%H:%M:%SZ")" \
+          --notes '' \
+          --target master \
+          --repo MatrixAI/TypeScript-Demo-Lib-Native;
+        '
   after_script:
     - rm -f ./.npmrc
   rules:
-    # Only npm release tags
+    # Only runs on tag pipeline where the tag is a release version
+    # This requires dependencies to also run on tag pipeline
+    # However version tag comes with a version commit
+    # Dependencies must not run on the version commit
     - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/