-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of github.com:isaqb-org/curriculum-foundation
- Loading branch information
Showing
14 changed files
with
347 additions
and
297 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
## Table of Contents | ||
- [Changes in 2025.1](#changes-in-20251) | ||
- [Very Short Summary](#very-short-summary) | ||
- [Summary](#summary) | ||
- [Detailed Change History](#detailed-change-history) | ||
|
||
# Changes in 2025.1 | ||
|
||
The baseline for the following comparison is the latest release of 2023.1 | ||
|
||
Abbreviations used below: | ||
|
||
* LG: Learning goal | ||
* LGI: Learning goal item (_bullet item_ within LG) | ||
* RC: Release candidate | ||
|
||
|
||
The list of fixed/resolved issues can be found in the [Kanban board](https://github.com/isaqb-org/curriculum-foundation/projects/7) on GitHub. | ||
For 2025.1, we have resolved more than XXX issues, comments and problems in both the English (EN) and German (DE) version. | ||
|
||
## Very Short Summary | ||
|
||
> some text | ||
## Summary | ||
|
||
* some more text | ||
|
||
## Detailed Change History | ||
In case you are curious, have a look at the commit history. | ||
Work relevant for 2025.1 has begun October 2023, and resulted in more than 120 commits to the repository. | ||
|
||
>Count commits across all branches: | ||
>`git rev-list --all --count --since="23 October 2023"` | ||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,110 +1,46 @@ | ||
import org.asciidoctor.gradle.jvm.AsciidoctorTask | ||
import java.text.SimpleDateFormat | ||
|
||
plugins { | ||
id "org.asciidoctor.jvm.base" version "3.3.2" | ||
id "org.asciidoctor.jvm.convert" version "3.3.2" | ||
id "org.asciidoctor.jvm.pdf" version "3.3.2" | ||
id "java" | ||
id "application" | ||
} | ||
|
||
def group = "org.isaqb" | ||
def releaseVersion = System.getenv("RELEASE_VERSION") | ||
def localVersion = "LocalBuild" | ||
project.version = releaseVersion == null ? localVersion : releaseVersion | ||
def curriculumFileName = "curriculum-foundation" | ||
def versionDate = new SimpleDateFormat("yyyyMMdd").format(new Date()) | ||
def languages = ["DE", "EN"] | ||
def validity = project.file("./document.validity").text.trim() | ||
|
||
repositories { | ||
mavenCentral() | ||
} | ||
|
||
asciidoctorj { | ||
version = '2.5.3' | ||
dependencies { | ||
implementation("org.asciidoctor:asciidoctorj:2.5.10") | ||
implementation("org.asciidoctor:asciidoctorj-pdf:2.3.9") | ||
} | ||
|
||
ext { | ||
today = new Date() | ||
versionDate = new SimpleDateFormat("yyyyMMdd").format(today) | ||
|
||
releaseVersion = System.getenv("RELEASE_VERSION") | ||
localVersion = "LocalBuild" | ||
project.version = releaseVersion == null ? localVersion : releaseVersion; | ||
|
||
validity = new Date(project.file("./document.validity").text.trim()) | ||
validityEnglish = "valid from " + new SimpleDateFormat("MMMM d, yyyy", Locale.US).format(validity) | ||
validityGerman = "Gültig ab " + new SimpleDateFormat("d. MMMM yyy", Locale.GERMANY).format(validity) | ||
|
||
curriculumFileName = "curriculum-foundation" | ||
addSuffixToCurriculum = { suffix -> | ||
for (extension in ["html", "pdf"]) { | ||
File source = new File("${buildDir}/${curriculumFileName}.${extension}") | ||
File target = new File("${buildDir}/${curriculumFileName}${suffix}.${extension}") | ||
|
||
source.renameTo(target) | ||
} | ||
} | ||
application { | ||
mainClass.set("org.isaqb.asciidoc.Main") | ||
applicationDefaultJvmArgs = [ | ||
"""-DprojectVersion=${project.version}""", | ||
"""-DcurriculumFileName=${curriculumFileName}""", | ||
"""-DversionDate=${versionDate}""", | ||
"""-Dlanguages=${languages.join(',')}""", | ||
"""-Dvalidity=${validity}""", | ||
"""--add-opens""", """java.base/sun.nio.ch=ALL-UNNAMED""", | ||
"""--add-opens""", """java.base/java.io=ALL-UNNAMED"""] | ||
} | ||
|
||
class RenderCurriculumTask extends AsciidoctorTask { | ||
@Inject | ||
RenderCurriculumTask(WorkerExecutor we, String curriculumFileName, String versionDate, String validity, String language) { | ||
super(we) | ||
|
||
forkOptions { | ||
jvmArgs "--add-opens", "java.base/sun.nio.ch=ALL-UNNAMED", "--add-opens", "java.base/java.io=ALL-UNNAMED" | ||
} | ||
|
||
|
||
sourceDir = new File("./docs/") | ||
baseDir = new File("./docs/") | ||
sources { | ||
include "index.adoc" | ||
include "${curriculumFileName}.adoc" | ||
} | ||
outputDir = new File("./build/") | ||
outputOptions { | ||
separateOutputDirs = false | ||
backends 'pdf', 'html5' | ||
} | ||
|
||
def fileVersion = project.version.trim() + "-" + language | ||
|
||
attributes = [ | ||
'icons' : 'font', | ||
'version-label' : '', | ||
'revnumber' : fileVersion, | ||
'revdate' : versionDate, | ||
'document-version' : fileVersion + "-" + versionDate + " (" + validity + ")", | ||
'currentDate' : versionDate, | ||
'language' : language, | ||
'curriculumFileName': curriculumFileName, | ||
'debug_adoc' : false, | ||
'pdf-stylesdir' : '../pdf-theme/themes', | ||
'pdf-fontsdir' : '../pdf-theme/fonts', | ||
'pdf-style' : 'isaqb', | ||
'stylesheet' : '../html-theme/adoc-github.css', | ||
'stylesheet-dir' : '../html-theme', | ||
'glossary_url' : 'https://public.isaqb.org/glossary/glossary-' + language.toLowerCase() + '.html#term-' | ||
] | ||
} | ||
} | ||
|
||
task buildDocs { | ||
group 'Documentation' | ||
description 'Grouping task for generating all languages in several formats' | ||
dependsOn "includeLearningGoals", "renderDE", "renderEN" | ||
} | ||
|
||
task renderDE(type: RenderCurriculumTask, | ||
constructorArgs: [curriculumFileName, versionDate, validityGerman, "DE"]) { | ||
group 'Documentation' | ||
description 'Builds the German curriculum as PDF and HTML file.' | ||
doLast { | ||
addSuffixToCurriculum("-de") | ||
} | ||
} | ||
apply from: 'scripts/includeLearningGoals.gradle' | ||
|
||
task renderEN(type: RenderCurriculumTask, | ||
constructorArgs: [curriculumFileName, versionDate, validityEnglish, "EN"]) { | ||
group 'Documentation' | ||
description 'Builds the English curriculum as PDF and HTML file.' | ||
doLast { | ||
addSuffixToCurriculum("-en") | ||
} | ||
tasks.register('buildDocs') { | ||
description = 'Grouping task for generating all languages in several formats' | ||
group = 'documentation' | ||
dependsOn "includeLearningGoals", "run" | ||
} | ||
|
||
apply from: 'scripts/includeLearningGoals.gradle' | ||
|
||
defaultTasks "buildDocs" |
Oops, something went wrong.