Merge pull request #135 from isaqb-org/132-improve-release-handling

Author: programming-wolf

.github/workflows/build_main.yml

@@ -31,17 +31,21 @@ jobs:
       with:
         distribution: 'temurin'
         java-version: 17
-    - name: Execute Gradle Build
-      uses: eskatos/gradle-command-action@v2
-      with:
-        # Gradle command line arguments, see gradle --help
-        gradle-version: 7.5.1
-        arguments: buildDocs
 
-    # do the following two things only for a release!
+    # If we're building a release, we need to set the variable RELEASE_VERSION
     - name: Set Environment Variables for Release Version
       if: startsWith(github.ref, 'refs/tags/')
       run: echo "RELEASE_VERSION=${GITHUB_REF:10}" >> $GITHUB_ENV
+
+    - name: Execute Gradle Build
+      uses: gradle/gradle-build-action@v2
+      env:
+        CI: true
+      with:
+        gradle-version: wrapper
+        arguments: buildDocs
+
+    # release and deploy only if we're building a release
     - name: Prepare Deployment
       if: startsWith(github.ref, 'refs/tags/')
       run: |

.github/workflows/build_pr.yml

@@ -30,8 +30,7 @@ jobs:
           distribution: 'temurin'
           java-version: 17
       - name: Execute Gradle Build
-        uses: eskatos/gradle-command-action@v2
+        uses: gradle/gradle-build-action@v2
         with:
-          # Gradle command line arguments, see gradle --help
-          gradle-version: 7.5.1
+          gradle-version: wrapper
           arguments: buildDocs

.github/workflows/build_releasecandidate.yml

@@ -34,11 +34,18 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: 17
+
+      # If we're building a release, we need to set the variable RELEASE_VERSION
+      - name: Set Environment Variables for Release Version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: echo "RELEASE_VERSION=${GITHUB_REF:10}" >> $GITHUB_ENV
+
       - name: Execute Gradle Build
-        uses: eskatos/gradle-command-action@v2
+        uses: gradle/gradle-build-action@v2
+        env:
+          CI: true
         with:
-          # Gradle command line arguments, see gradle --help
-          gradle-version: 7.5.1
+          gradle-version: wrapper
           arguments: buildDocs
 
       # do the following two things only for a release!

CHANGELOG.md

@@ -1,6 +1,12 @@
-# New in 2020.6
+# Release Notes
+## New in 2020.7
+- Remove lots of old/unused stuff regarding remarks
+- Use Gradle Wrapper in GitHub Actions
+- Take document version from git tag
+
+## New in 2020.6
 
 - CHANGELOG can be created from file
 - Use new and simplified release action
 - Update to latest Aciidoctor versions
-- Update to latest Gradle
+- Update to latest Gradle (7.5.1)

README.adoc

@@ -52,7 +52,6 @@ git clone https://github.com/isaqb-org/advanced-template.git --recursive
 . Open the file `build.gradle` to adjust attributes specific to your curriculum:
 [loweralpha]
 .. `curriculumFileName`: the name of the asciidoc root file of your curriculum e.g. `curriculum-flex` (see above! The `.adoc` suffix is added automatically, omit it here!)
-. Edit the file `document.version` and enter the version number this new version of the curriculum shall have e.g. "2020.1".
 . Open README.adoc and replace the string `curriculum-template` with the name of your Github repository e.g. `curriculum-flex`
 . Build the project with http://www.gradle.com[gradle] (you need a locally installed JDK) via `./gradlew`.
 . Once the "BUILD SUCCESSFUL" is show, you can review the build result under `./build/index.html`

build.gradle

@@ -18,7 +18,10 @@ ext {
     today = new Date()
     versionDate = new SimpleDateFormat("yyyyMMdd").format(today)
 
-    project.version = project.file("./document.version").text
+    releaseVersion = System.getenv("RELEASE_VERSION")
+    localVersion = "LocalBuild"
+    project.version = releaseVersion == null ? localVersion : releaseVersion;
+
     curriculumFileName = "curriculum-template"
     addSuffixToCurriculum = { suffix ->
         for (extension in ["html", "pdf"]) {