Re-add files to build on local Jenkins

Author: qvacua

bin/build_jenkins.sh

@@ -0,0 +1,62 @@
+#!/bin/bash
+set -Eeuo pipefail
+
+readonly branch=${branch:?"which branch to use"}
+
+main() {
+  echo "### Releasing VimR started"
+
+  pushd "$(dirname "${BASH_SOURCE[0]}")/.." >/dev/null
+
+  git submodule update --init
+
+  ./bin/set_new_versions.sh
+
+  # commit and push the tag
+  # get the marketing version to be used as tag
+  source release.spec.sh
+
+  if [[ "${is_snapshot}" == true ]]; then
+    tag_name="snapshot/${bundle_version}"
+  else
+    tag_name="${marketing_version}-${bundle_version}"
+  fi
+  echo "### Using ${tag_name} as tag name"
+  git commit -am "Bump version to ${tag_name}"
+  git tag -am "${tag_name}"
+  git push
+  git push origin "${tag_name}"
+
+  echo "### Store release notes"
+  echo "${release_notes}" > release-notes.temp.md
+
+  echo "### Build VimR"
+
+  # FOR DEV
+  export create_gh_release=false
+  export upload=false
+
+  release_spec_file=release.spec.sh ./bin/build_release.sh
+
+  if [[ "${create_gh_release}" == false ]]; then
+    echo "### No github release, so exiting after building"
+    exit 0
+  fi
+
+  echo "### Commit appcast"
+  if [[ "${update_appcast}" == true ]]; then
+    if [[ "${is_snapshot}" == false ]]; then
+      cp appcast.xml appcast_snapshot.xml
+    fi
+
+    git commit appcast* -m "Update appcast"
+    git push
+  fi
+
+  popd >/dev/null
+
+  echo "### Releasing VimR ended"
+}
+
+main
+

bin/build_release.sh

@@ -128,10 +128,13 @@ main() {
     prepare_bin
     build_release
 
-    if [[ "${create_gh_release}" == true ]]; then
-      create_gh_release
+    if [[ "${create_gh_release}" == false ]]; then
+      echo "### No github release, exiting"
+      exit 0
     fi
 
+    create_gh_release
+
     if [[ "${upload}" == true ]]; then
       # Give GitHub some time.
       sleep 5

bin/set_new_versions.sh

@@ -63,20 +63,20 @@ declare -r -x github_release_name=${github_release_name}
 declare -r -x release_notes=\$(cat release-notes.temp.md)
 
 # Add release notes to release-notes.temp.md and issue
-# create_gh_release=true upload=true update_appcast=true release_spec_file=${bundle_version}-${version_marker}.sh ./bin/build_release.sh
+# create_gh_release=true upload=true update_appcast=true release_spec_file=release.spec.sh ./bin/build_release.sh
 END
 )
   readonly output
 
   local output_exec
   output_exec=$(cat <<-END
-create_gh_release=true upload=true update_appcast=true release_spec_file=${bundle_version}-${version_marker}.sh ./bin/build_release.sh
+create_gh_release=true upload=true update_appcast=true release_spec_file=release.spec.sh ./bin/build_release.sh
 END
 )
   readonly output_exec
 
   echo "Release notes" > release-notes.temp.md
-  echo "${output}" > "${bundle_version}-${version_marker}.sh"
+  echo "${output}" > "release.spec.sh"
   echo "${output_exec}" > "build_release.temp.sh"
   chmod +x "build_release.temp.sh"
 
@@ -85,7 +85,7 @@ END
   echo ""
   echo "### Use the following to build a release:"
   echo ""
-  echo "release_spec_file=${bundle_version}-${version_marker}.sh \\"
+  echo "release_spec_file=release.spc.sh \\"
   echo "create_gh_release=true upload=true update_appcast=true \\"
   echo "./bin/build_release.sh"
   echo ""

ci/README.md

@@ -0,0 +1,19 @@
+* Install Jenkins (via brew)
+* Install plugins
+    - Job DSL
+    - AnsiColor
+* Set the `git` binary in *Manage Jenkins* -> *Global Tool Configuration*
+* Set `PATH` for Jenkins (necessary for e.g. `git-lfs`) in *Manage Jenkins* -> *Configure System* -> *Global properties* -> *Environment variables"
+* Add a free style job `vimr_setup_jobs` with one step to process a Job DSL file at `ci/create_build_job.groovy`.
+  - Approve script at *Manager Jenkins* -> *In-process Script Approval*.
+
+---
+
+To test the job creation using local git repository, use `file:///Users/.../vimr-repo` as repository and add "-Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true" to `/opt/homebrew/opt/jenkins/bin/jenkins`:
+
+```bash
+#!/bin/bash
+export JAVA_HOME="${JAVA_HOME:-/opt/homebrew/opt/openjdk/libexec/openjdk.jdk/Contents/Home}"
+exec "${JAVA_HOME}/bin/java" "-Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true" "-jar" "/opt/homebrew/Cellar/jenkins/2.435/libexec/jenkins.war" "$@"
+```
+

ci/create_build_job.groovy

@@ -0,0 +1,47 @@
+// Install the following plugins in addition to recommended plugins when installing Jenkins
+// - Job DSL
+// - AnsiColor
+
+def buildSnapshotJob = freeStyleJob('vimr_build')
+
+buildSnapshotJob.with {
+  description 'Builds a new snapshot or a new release'
+
+  logRotator {
+    numToKeep(10)
+  }
+
+  parameters {
+    stringParam('marketing_version', null, 'Eg "0.34.0". If "is_snapshot" is unchecked, you have to enter this.')
+    booleanParam('is_snapshot', true)
+    stringParam('branch', 'master', 'Branch to build; defaults to master')
+    textParam('release_notes', null, 'Release notes')
+    booleanParam('create_gh_release', false, 'Publish this release to Github?')
+    booleanParam('upload', false, 'Upload VimR to Github?')
+    booleanParam('update_appcast', false)
+  }
+
+  scm {
+    git {
+      remote {
+        url('[email protected]:qvacua/vimr.git')
+      }
+      branch('*/${branch}')
+    }
+  }
+
+  wrappers {
+    colorizeOutput()
+  }
+
+  steps {
+    shell('./bin/build_jenkins.sh')
+  }
+
+  publishers {
+    archiveArtifacts {
+      pattern('build/Build/Products/Release/**')
+      onlyIfSuccessful()
+    }
+  }
+}