From d93e26fc7cdbc8f111a78f04f1bc3076e3047049 Mon Sep 17 00:00:00 2001 From: Markus Schmidt Date: Tue, 31 Oct 2023 11:47:01 +0100 Subject: [PATCH] add version from latest tag to keep the installation doc up2date w/ current release --- .github/workflows/gh-pages.yml | 1 + docs/installation.md | 30 +++++++++++++++--------------- mkdocs.yml | 1 + 3 files changed, 17 insertions(+), 15 deletions(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 8f2fde8c7b9..d12ccd90d3d 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -20,6 +20,7 @@ jobs: - run: pip install mkdocs-material - run: pip install mkdocs-tooltips - run: pip install git+https://github.com/RedisLabs/mkdocs-include.git + - run: pip install mkdocs_latest_release_plugin - run: pip install git+https://github.com/swissiety/LspLexer4Pygments.git # grab latest release url of the JimpleLSP jar and download it - run: curl -s -L -o ./jimplelsp.jar $(curl -s https://api.github.com/repos/swissiety/jimpleLsp/releases/latest | grep 'browser_download_url".*jar"' | cut -d ':' -f 2,3 | tr -d \") diff --git a/docs/installation.md b/docs/installation.md index f561370c6ec..eeef216d977 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -15,37 +15,37 @@ Take a look at the [Modules](whatsnew.md#modular-architecture) to learn more abo org.soot-oss sootup.core - 1.0.0 + {{ git_latest_release }} org.soot-oss sootup.java.core - 1.0.0 + {{ git_latest_release }} org.soot-oss sootup.java.sourcecode - 1.0.0 + {{ git_latest_release }} org.soot-oss sootup.java.bytecode - 1.0.0 + {{ git_latest_release }} org.soot-oss sootup.jimple.parser - 1.0.0 + {{ git_latest_release }} org.soot-oss sootup.callgraph - 1.0.0 + {{ git_latest_release }} org.soot-oss sootup.analysis - 1.0.0 + {{ git_latest_release }} ``` @@ -54,13 +54,13 @@ Take a look at the [Modules](whatsnew.md#modular-architecture) to learn more abo Add the following dependency in the ```build.gradle``` file of your project to include all SootUp modules into your project. ``` -compile "org.soot-oss:sootup.core:1.0.0" -compile "org.soot-oss:sootup.java.core:1.0.0" -compile "org.soot-oss:sootup.java.sourcecode:1.0.0" -compile "org.soot-oss:sootup.java.bytecode:1.0.0" -compile "org.soot-oss:sootup.jimple.parser:1.0.0" -compile "org.soot-oss:sootup.callgraph:1.0.0" -compile "org.soot-oss:sootup.analysis:1.0.0" +compile "org.soot-oss:sootup.core:{{ git_latest_release }}" +compile "org.soot-oss:sootup.java.core{{ git_latest_release }}" +compile "org.soot-oss:sootup.java.sourcecode{{ git_latest_release }}" +compile "org.soot-oss:sootup.java.bytecode{{ git_latest_release }}" +compile "org.soot-oss:sootup.jimple.parser{{ git_latest_release }}" +compile "org.soot-oss:sootup.callgraph{{ git_latest_release }}" +compile "org.soot-oss:sootup.analysis{{ git_latest_release }}" ``` ## Building from Source @@ -79,7 +79,7 @@ Alternatively, you can execute the following command in the project directory: mvn install ``` -Or if you want to skip unit tests while building: +Or if you want to skip tests while building: ``` mvn -Dskiptests install diff --git a/mkdocs.yml b/mkdocs.yml index 0d6610bfb85..7a72a682ae4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,6 +33,7 @@ plugins: - search - include: src_path: 'sootup.examples/src/test/java/sootup/examples' + - git-latest-release extra_css: - css/hint.min.css