Skip to content

Commit

Permalink
update release template for MacOS
Browse files Browse the repository at this point in the history
  • Loading branch information
jon gadsden committed Jun 21, 2023
1 parent cc27937 commit 8b663aa
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ jobs:
- name: Checkout markdown
uses: actions/[email protected]

# 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/[email protected]
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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ jobs:
uses: irongut/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
id: ${{ github.event.release.id }}
id: '2.0.3'
body: 'Released to GitHub Packages.'
files: '.release-note-template.md'

Expand Down
2 changes: 1 addition & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
27 changes: 19 additions & 8 deletions .release-note-template.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,35 @@
**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 |
|Linux AppImage | Threat-Dragon-ng-2.0.2.AppImage | latest-linux.yml |
|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

0 comments on commit 8b663aa

Please sign in to comment.