diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 40183808c..ba0f2a654 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -34,12 +34,12 @@ jobs: - name: Checkout markdown uses: actions/checkout@v3.5.2 - # use **/*.md for all markdown files in project + # do not use **/*.md as this will include the third party packages - name: Lint markdown uses: DavidAnson/markdownlint-cli2-action@v11.0.0 with: config: '.markdownlint.yaml' - globs: '*.md td.*/*.md .github/**/*.md docs/**/*.md' + globs: '.*.md *.md td.*/*.md .github/**/*.md docs/**/*.md' codeql: name: Analyze with codeql diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 9cd79fd43..7b05e5f5c 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -387,7 +387,7 @@ jobs: uses: irongut/EditRelease@v1.2.0 with: token: ${{ secrets.GITHUB_TOKEN }} - id: ${{ github.event.release.id }} + id: '2.0.3' body: 'Released to GitHub Packages.' files: '.release-note-template.md' diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 173fb19c8..5e14f5683 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -10,7 +10,7 @@ MD013: code_blocks: true heading_line_length: 80 headings: true - line_length: 120 + line_length: 128 stern: true strict: false tables: true diff --git a/.release-note-template.md b/.release-note-template.md index d13c5beb8..aba746626 100644 --- a/.release-note-template.md +++ b/.release-note-template.md @@ -1,8 +1,10 @@ -**Web Application** -The web application is provided as a [.tar.gz file](https://github.com/OWASP/threat-dragon/archive/refs/tags/v2.0.1.tar.gz) or a [.zip file](https://github.com/OWASP/threat-dragon/archive/refs/tags/v2.0.2.zip) with software bills of materials ([SBOMs](https://github.com/OWASP/threat-dragon/releases/download/v2.0.2/threat-dragon-sboms.zip)) +### Web application -**Desktop version** -|Platform | File | checksum | +The web application is provided as a [.tar.gz file][tar] or a [.zip file][zip] with a software bill of materials ([SBOM][sboms]) + +### Desktop version + +|Platform | File | checksum | |-- | -- | -- | |Windows NSIS installer | Threat-Dragon-ng-Setup-2.0.2.exe | latest.yml | |MacOS installer | Threat-Dragon-ng-2.0.2.dmg | latest-mac.yml | @@ -10,15 +12,24 @@ The web application is provided as a [.tar.gz file](https://github.com/OWASP/thr |Debian package, AMD64 | threat-dragon_2.0.2_amd64.deb | | |Redhat package manager, X86 64 bit | threat-dragon-2.0.2.x86_64.rpm | | -**Running on Windows** -Depending on the security applied in your Windows, you may need open the file properties and check the 'Unblock' checkbox to allow Threat Dragon to run +**Installing on Windows** +Depending on the security applied in your Windows, you may need to open the file properties +and check the 'Unblock' checkbox to allow Threat Dragon to run + +**Installing on MacOS** +Use the disk image (`.dmg`) file to install on MacOS systems, the Threat Dragon `.zip` +is used for the automatic updates only **Selecting the Linux package to use** `AppImage` can be used for most Linux distributions and hardware platforms -Snap image is available via [official snapcraft distribution](https://snapcraft.io/threat-dragon) +The Snap image is available from the [official snapcraft distribution][snap] `.rpm` for Red Hat Linux, AIX, CentOS, Fedora `.deb` for debian based Linux, such as Ubuntu, Trisqel and Debian itself -**Docker** +**Docker container** Pull from docker hub using `docker pull --platform linux/x86_64 owasp/threat-dragon:v2.0.2` +[sboms]: https://github.com/OWASP/threat-dragon/releases/download/v2.0.2/threat-dragon-sboms.zip +[snap]: https://snapcraft.io/threat-dragon +[tar]: https://github.com/OWASP/threat-dragon/archive/refs/tags/v2.0.2.tar.gz +[zip]: https://github.com/OWASP/threat-dragon/archive/refs/tags/v2.0.2.zip