diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index db57642..6003919 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,14 @@ -**When merged this pull request will:** +## When merged this pull request will: + - Describe what this pull request will do - Each change in a separate line -### Important -- [ ] If the contribution affects the documentation, please include your changes in this pull request. +## Important + - [ ] [Development Guidelines](https://github.com/TacticalTrainingTeam/TTT_PartnerMod/blob/main/.github/CONTRIBUTING.md) are read, understood and applied. - [ ] Title of this PR uses our standard template `Component - Add|Fix|Improve|Change|Remove {changes}`. -### Known Issues +## Known Issues + - [ ] Issue diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..36bc757 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,50 @@ +branches: + - main + +# The version isn't resolved from PR labels — script_version.hpp and the +# git tag created at release time are the source of truth. Retitle/retag +# this draft to match before publishing. +name-template: 'Unreleased' +tag-template: 'unreleased' + +sort-by: title # sort alphabetically +sort-direction: ascending + +# Category names match Keep a Changelog (https://keepachangelog.com/en/1.1.0/) +# so a drafted release's notes group changes the same way CHANGELOG.md does. +categories: + - title: 'Added' + labels: + - 'changelog/added' + - title: 'Changed' + labels: + - 'changelog/changed' + - title: 'Deprecated' + labels: + - 'changelog/deprecated' + - title: 'Removed' + labels: + - 'changelog/removed' + - title: 'Fixed' + labels: + - 'changelog/fixed' + - title: 'Security' + labels: + - 'changelog/security' + +exclude-labels: + - 'ignore-changelog' + - 'tools' + - 'documentation' + +change-template: '* $TITLE (#$NUMBER) by $AUTHOR' +template: | + _Requires the latest Version of [CBA](https://github.com/CBATeam/CBA_A3) and [ACE](https://github.com/acemod/ACE3)._ + + ## Summary + + $CHANGES + + ## Contributors + + $CONTRIBUTORS diff --git a/.github/workflows/hemtt.yml b/.github/workflows/check.yml similarity index 90% rename from .github/workflows/hemtt.yml rename to .github/workflows/check.yml index d5026cb..cdd6df8 100644 --- a/.github/workflows/hemtt.yml +++ b/.github/workflows/check.yml @@ -17,4 +17,4 @@ jobs: - name: Setup HEMTT uses: arma-actions/hemtt@v1 - name: Run HEMTT check - run: hemtt check -p -vvv + run: hemtt check diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000..1445672 --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,23 @@ +name: Release Drafter + +on: + push: + branches: + - main + +permissions: + contents: read + +jobs: + draft: + if: github.repository == 'TacticalTrainingTeam/TTT_PartnerMod' + permissions: + # write permission is required to create a github release + contents: write + pull-requests: write + runs-on: ubuntu-latest + steps: + - name: Draft Release + uses: release-drafter/release-drafter@v6 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 43ef3a8..c075521 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,27 +1,36 @@ -name: Upload Release +# This action will use hemtt release to build and sign the mod, then +# attach the resulting zip to the GitHub release. +# +# Steam Workshop publishing is handled separately via `hemtt publish` +# (https://hemtt.dev), not by this workflow. + +name: Release on: release: - types: [ "published" ] + types: released + +permissions: + contents: write jobs: - release: + release-addon: runs-on: ubuntu-latest steps: - - name: Checkout the source code - uses: actions/checkout@v7 + - name: Checkout the source code + uses: actions/checkout@v7 - - name: Setup HEMTT - uses: arma-actions/hemtt@v1 + - name: Setup HEMTT + uses: arma-actions/hemtt@v1 - - name: Build TTT Partner Mod Release - run: hemtt release + - name: Run HEMTT build + run: hemtt release - - name: Upload to release - uses: svenstaro/upload-release-action@v2 - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: releases/ttt_pm-latest.zip - asset_name: ttt_pm-$tag.zip - tag: ${{ github.ref }} - overwrite: true + - name: Upload release to GitHub + uses: svenstaro/upload-release-action@v2 + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: releases/ttt_pm-latest.zip + asset_name: ttt_pm-${{ github.ref_name }}.zip + tag: ${{ github.ref }} + overwrite: true diff --git a/.github/workflows/arma.yml b/.github/workflows/validate.yml similarity index 78% rename from .github/workflows/arma.yml rename to .github/workflows/validate.yml index 59c6362..3964091 100644 --- a/.github/workflows/arma.yml +++ b/.github/workflows/validate.yml @@ -14,11 +14,7 @@ jobs: steps: - name: Checkout the source code uses: actions/checkout@v7 - - name: Validate Config - run: python tools/config_style_checker.py - name: Validate Stringtables run: python3 tools/stringtable_validator.py - - name: Check for BOM - uses: arma-actions/bom-check@master - with: - path: "addons" + - name: Validate Config + run: python tools/config_style_checker.py diff --git a/.hemtt/project.toml b/.hemtt/project.toml index cc3966b..3fe704b 100644 --- a/.hemtt/project.toml +++ b/.hemtt/project.toml @@ -13,7 +13,7 @@ include = [ "meta.cpp", "logo_ttt_pm.png", "logo_ttt_pm_ca.paa", - "LICENSE.md", + "LICENSE", "README.md", ] exclude = [] diff --git a/LICENSE.md b/LICENSE similarity index 100% rename from LICENSE.md rename to LICENSE diff --git a/README.md b/README.md index 8bf8a5d..9fdbfb2 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,12 @@ TTT_PartnerMod Issues - + TTT_PartnerMod License
- HEMTT - Validate + Check + Validate

@@ -31,7 +31,7 @@ by providing ingame access to the Community Logos via ACE-Tagging. The project is entirely **open-source** and any contributions are welcome. -## Core Features +## Features - Add a new Spraypaint that allows the user to tag an object with the four Community Logos - Add the Numbers 0-9 to the Black Spraypaint @@ -44,4 +44,4 @@ For new contributors, see the [Contributing Setup & Guidelines](./.github/CONTRI ## License -TTT_PartnerMod is licensed under [APL-ND](./LICENSE.md). +TTT_PartnerMod is licensed under [APL-ND](./LICENSE). diff --git a/workshop/steam_description.txt b/workshop/steam_description.txt new file mode 100644 index 0000000..82496d3 --- /dev/null +++ b/workshop/steam_description.txt @@ -0,0 +1,38 @@ +[h1]TTT Partner Mod[/h1] + +[b]TTT Partner Mod[/b] (TTT PM) aims to enhance the gameplay of [url=https://www.tacticalteam.de]Tactical Training Team[/url] and its partners: + +[list] +[*] [url=https://www.gruppe-w.de]Gruppe W[/url] +[*] [url=https://gruppe-adler.de/]Gruppe Adler[/url] +[*] [url=https://prae-garde.de]Praetorianische Garde[/url] +[/list] + +by providing ingame access to the community logos via ACE-Tagging. + +[h1]Requirements[/h1] + +[list] +[*] [url=https://github.com/CBATeam/CBA_A3]CBA_A3[/url] +[*] [url=https://github.com/acemod/ACE3]ACE3[/url] +[/list] + +[h1]Features[/h1] + +[list] +[*] Add a new spraypaint that allows the user to tag an object with the four community logos +[*] Add the numbers 0-9 to the black spraypaint +[/list] + +[h1]Source & Issues[/h1] + +Fully open-source. Bug reports, feature requests, and contributions are all welcome. + +[url=https://github.com/TacticalTrainingTeam/TTT_PartnerMod]GitHub Repository[/url] +[url=https://github.com/TacticalTrainingTeam/TTT_PartnerMod/issues]Report an Issue[/url] + +Licensed under [url=https://github.com/TacticalTrainingTeam/TTT_PartnerMod/blob/main/LICENSE]APL-ND[/url]. + +--- + +Suchst du eine deutschsprachige Arma3 und Reforger Community? -> https://www.tacticalteam.de/mitmachen