Merge pull request #46 from isaqb-org/apply-template-updates

Apply Template Updates
isaqb-org · Jul 11, 2024 · 8df7e42 · 8df7e42
2 parents 3b63a1d + b5536d9
commit 8df7e42
Show file tree

Hide file tree

Showing 19 changed files with 278 additions and 338 deletions.
diff --git a/.github/workflows/build_main.yml b/.github/workflows/build_main.yml
@@ -10,71 +10,6 @@ on:
     tags:
       - "[2-9][0-9][0-9][0-9].[0-9]+-rev[0-9]+"
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-    - name: Checkout Source
-      uses: actions/checkout@v3
-      with:
-        submodules: recursive
-    - name: Verify Gradle Wrapper
-      uses: gradle/wrapper-validation-action@v1
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      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: 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: |
-        rm -rf ./build/tmp
-        cp ./docs-ext/curriculum-*.pdf ./build 2>/dev/null || :
-        zip -r release.zip ./build
-        mkdir release_dir
-        cp ./build/curriculum-*.pdf ./release_dir 2>/dev/null || :
-        mv release.zip ./release_dir/release-${{ env.RELEASE_VERSION }}.zip
-    - name: Create New Release
-      if: startsWith(github.ref, 'refs/tags/')
-      id: create-release
-      uses: ncipollo/release-action@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-      with:
-        tag: ${{ env.RELEASE_VERSION }}
-        name: Release ${{ env.RELEASE_VERSION }}
-        draft: false
-        prerelease: false
-        bodyFile: "CHANGELOG.md"
-        artifacts: "license-copyright/LICENSE.adoc,release_dir/*.pdf,release_dir/*.zip"
-        token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Deploy
-      if: startsWith(github.ref, 'refs/tags/')
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./build
-        user_name: 'github-actions[bot]'
-        user_email: 'github-actions[bot]@users.noreply.github.com'
-        commit_message: Publish Release ${{ env.RELEASE_VERSION }}
+  call_workflow_build:
+    uses: isaqb-org/github-workflows/.github/workflows/build_main.yml@main
diff --git a/.github/workflows/build_pr.yml b/.github/workflows/build_pr.yml
@@ -6,31 +6,8 @@ name: CI – Pull Requests
 # events but only for the main branch
 on:
   pull_request:
-
     branches: [ main ]
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
-jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: checkout source
-        uses: actions/checkout@v3
-        with:
-          submodules: recursive
-      - name: Verify Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
-      - name: Set up JDK 17
-        uses: actions/setup-java@v3
-        with:
-          distribution: 'temurin'
-          java-version: 17
-      - name: Execute Gradle Build
-        uses: gradle/gradle-build-action@v2
-        with:
-          gradle-version: wrapper
-          arguments: buildDocs
+jobs:
+  call_workflow_build_pr:
+    uses: isaqb-org/github-workflows/.github/workflows/build_pr.yml@main
diff --git a/.github/workflows/build_releasecandidate.yml b/.github/workflows/build_releasecandidate.yml
@@ -9,77 +9,6 @@ on:
     tags:
       - "[2-9][0-9][0-9][0-9].[0-9]+-RC[0-9]+"
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: Checkout Source
-        uses: actions/checkout@v3
-        with:
-          submodules: recursive
-      - name: Update index.adoc
-        run: |
-          rm docs/index.adoc
-          mv docs/index_rc.adoc docs/index.adoc
-      - name: Verify Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
-      - name: Set up JDK 17
-        uses: actions/setup-java@v3
-        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: gradle/gradle-build-action@v2
-        env:
-          CI: true
-        with:
-          gradle-version: wrapper
-          arguments: buildDocs
-
-      # do the following two things only for a release!
-      - name: Prepare Deployment
-        if: startsWith(github.ref, 'refs/tags/')
-        run: |
-          rm -rf ./build/tmp
-          cp ./docs-ext/curriculum-*.pdf ./build 2>/dev/null || :
-          zip -r release.zip ./build
-          mkdir release_dir
-          cp ./build/curriculum-*.pdf ./release_dir 2>/dev/null || :
-          mv release.zip ./release_dir/release-${{ env.RELEASE_VERSION }}.zip
-      - name: Create New Release Candidate
-        if: startsWith(github.ref, 'refs/tags/')
-        id: create-release-candidate
-        uses: ncipollo/release-action@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-        with:
-          tag: ${{ env.RELEASE_VERSION }}
-          name: Release Candidate ${{ env.RELEASE_VERSION }}
-          draft: false
-          prerelease: true
-          bodyFile: "CHANGELOG.md"
-          artifacts: "license-copyright/LICENSE.adoc,release_dir/*.pdf,release_dir/*.zip"
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Deploy Release Candidate to GitHub Pages
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build
-          destination_dir: release-candidate
-          keep_files: true
-          user_name: 'github-actions[bot]'
-          user_email: 'github-actions[bot]@users.noreply.github.com'
-          commit_message: Publish Release Candidate ${{ env.RELEASE_VERSION }}
+  call_workflow_build_pr:
+    uses: isaqb-org/github-workflows/.github/workflows/build_releasecandidate.yml@main
diff --git a/.github/workflows/update_pr_with_comment.yml b/.github/workflows/update_pr_with_comment.yml
@@ -0,0 +1,10 @@
+name: Comment on Pull Request
+
+on:
+  workflow_run:
+    types: [completed]
+    workflows: [CI – Pull Requests]
+
+jobs:
+  call_workflow_build:
+    uses: isaqb-org/github-workflows/.github/workflows/update_pr_with_comment.yml@main
diff --git a/README.adoc b/README.adoc
@@ -1,22 +1,13 @@
-= image:./docs/isaqb-logo.jpg[iSAQB,150] Curriculum for the CPSA-advanced module IMPROVE
+= https://isaqb.org[iSAQB] Curriculum for the CPSA-advanced Module IMPROVE
+
 :toc:
 :toc-placement!:
 
-
-## Update 2024
+== Update 2024
 
 For open, closed and in-progress-issues: see our https://github.com/orgs/isaqb-org/projects/4[Kanban-Board]
 
-
-ifdef::env-github[]
-:tip-caption: :bulb:
-:note-caption: :information_source:
-:important-caption: :heavy_exclamation_mark:
-:caution-caption: :fire:
-:warning-caption: :warning:
-endif::[]
-
-== Status 
+== Status
 image:https://github.com/isaqb-org/curriculum-improve/workflows/CI%20-%20Releases%20and%20Main/badge.svg?branch=main["CI"]
 image:https://img.shields.io/github/last-commit/isaqb-org/curriculum-improve/main.svg["Last commit"]
 image:https://img.shields.io/github/contributors/isaqb-org/curriculum-improve.svg["Contributors",link="https://github.com/isaqb-org/curriculum-improve/graphs/contributors"]
@@ -26,26 +17,31 @@ image:https://img.shields.io/github/issues-closed/isaqb-org/curriculum-improve.s
 
 This is <<copyrighted,copyrighted work>>.
 
-This repository contains the AsciiDoc sourcees of the curriculum for the iSAQB Advanced Level "IMPROVE". 
+== Content
+This repository contains the AsciiDoc sources of the curriculum for the iSAQB Advanced Level "IMPROVE".
 
-== Content of this "readme"
 toc::[]
 
 == How to contribute or participate
 Create an issue, a merge- or pull-request
 
 == How to use this template
 
-. Either click on "Use this template" in the Github UI or Clone the repository - including the submodule:
+. Clone the repository - including the submodule:
 +
 --
 [source,shell]
 ----
-git clone [email protected]/isaqb-org/curriculum-improve.git --recursive
+Via SSH:
+git clone [email protected]:isaqb-org/curriculum-improve.git --recursive
+
+Via HTTPS:
+git clone https://github.com/isaqb-org/curriculum-improve.git --recursive
 ----
 --
-2. Build it with gradle via `./gradle`.
-3. Look into the file `build.gradle` to see what attributes you may configure. Watch for:
+
+. Build it with gradle via `./gradle`.
+. Look into the file `build.gradle` to see what attributes you may configure. Watch for:
 ** the `language` attribute, either `DE` (German) or `EN` (English);
 ** the output formats called `backends` (pdf and/or html5);
 ** the document version.
@@ -63,24 +59,11 @@ This repository is currently maintained by Gernot Starke, Markus Harrer, and Ben
 It was forked from https://github.com/isaqb-org/advanced-template, so the contributors of that project basically contributed to this one, too.
 
 
-== Contributors
+== More Contributors
 
 Parts of the content origined from the https://aim42.org[aim42 open source method] for architecture improvement. Thanx to all https://github.com/aim42/aim42/graphs/contributors[contributors] of aim42!
 
 
-== Releases and Versions
-
-* The iSAQB Advanced working group is responsible for official releases.
-* Gernot Starke is currently leading maintainer of IMPROVE.
-
-=== Current release
-* The latest official version is v 1.6.
-* Release 2021.1 is under way (with only minor content changes, but generated from Asciidoc)
-
-== iSAQB Contact Information
-
-* iSAQB office: -> https://isaqb.org[iSAQB website]
-* iSAQB working group, responsible for curriculum content: advanced - at - isaqb - dot - org
 
 [[copyrighted]]
 == Licensing and Copyright