diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f52521e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,7 @@ +# Auto detect text files and perform LF normalization +* text=auto + +*.sh text eol=lf + +# Custom for Visual Studio +*.cs diff=csharp diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..079a32b --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at **[TODO@example.com](mailto:TODO@example.com)**. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..263eaad --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,2 @@ +## Pull request + diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md new file mode 100644 index 0000000..4db66fb --- /dev/null +++ b/.github/RELEASE_TEMPLATE.md @@ -0,0 +1,3 @@ +### Changelog + +This is automated GitHub deployment, human-readable changelog should be available soon. diff --git a/.github/renovate.json5 b/.github/renovate.json5 new file mode 100644 index 0000000..f1da4d4 --- /dev/null +++ b/.github/renovate.json5 @@ -0,0 +1,16 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base", + ":assignee(Rudokhvist)", + ":automergeBranch", + ":automergeDigest", + ":automergeMinor", + ":disableDependencyDashboard", + ":disableRateLimiting", + ":label(🤖 Automatic)" + ], + "git-submodules": { + "enabled": true + } +} diff --git a/.github/workflows/bump-asf-reference.yml b/.github/workflows/bump-asf-reference.yml new file mode 100644 index 0000000..7fd4ad2 --- /dev/null +++ b/.github/workflows/bump-asf-reference.yml @@ -0,0 +1,80 @@ +# This action is responsible for automatically bumping the ArchiSteamFarm submodule reference to the latest stable release +# Please note that this DOES NOT update the actual commit the submodule itself is binded to, as that part is the responsibility of the developer or chosen dependencies management tool (such as Renovate or Dependabot), that will actually build and test whether the plugin project requires any kind of corrections before doing so +# Because of that, commit created through this workflow can't possibly create any kind of build regression, as we only limit the actual commit the above action can actually update to +# Note: If you'd like to change the default channel from stable to pre-releases, simply change RELEASE_TYPE +name: Plugin-bump-asf-reference + +on: + schedule: + - cron: '17 1 * * *' + + workflow_dispatch: + +env: + # You can specify your own credentials if you'd like to, simply change ARCHIBOT_GPG_PRIVATE_KEY and/or ARCHIBOT_GITHUB_TOKEN secrets here to the ones you want to use + GPG_PRIVATE_KEY: ${{ secrets.ARCHIBOT_GPG_PRIVATE_KEY }} # Optional, if secret not provided, will skip signing commit with GPG key + PUSH_GITHUB_TOKEN: ${{ secrets.ARCHIBOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} # Optional, if secret not provided, will use the default token + RELEASE_TYPE: stable # Recommended to choose one from: stable (latest ASF stable release), nodraft (latest ASF release, including pre-releases, but without drafts) + +permissions: + contents: write + +jobs: + main: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4.1.7 + with: + show-progress: false + token: ${{ env.PUSH_GITHUB_TOKEN }} + + - name: Fetch latest ArchiSteamFarm release + id: asf-release + uses: rez0n/actions-github-release@v2.0 + env: + repository: JustArchiNET/ArchiSteamFarm + token: ${{ secrets.GITHUB_TOKEN }} + type: ${{ env.RELEASE_TYPE }} + + - name: Import GPG key for signing + uses: crazy-max/ghaction-import-gpg@v6.1.0 + if: ${{ env.GPG_PRIVATE_KEY != null }} + with: + gpg_private_key: ${{ env.GPG_PRIVATE_KEY }} + git_user_signingkey: true + git_commit_gpgsign: true + + - name: Update ASF reference if needed + env: + LATEST_ASF_RELEASE: ${{ steps.asf-release.outputs.release }} + shell: sh + run: | + set -eu + + current_version="$(git config -f .gitmodules submodule.ArchiSteamFarm.branch)" + + if dpkg --compare-versions "$current_version" "ge" "$LATEST_ASF_RELEASE"; then + exit + fi + + git config -f .gitmodules submodule.ArchiSteamFarm.branch "$LATEST_ASF_RELEASE" + + git add -A ".gitmodules" + + if ! git config --get user.email > /dev/null; then + git config --local user.email "action@github.com" + fi + + if ! git config --get user.name > /dev/null; then + git config --local user.name "GitHub Action" + fi + + git commit -m "Automatic ArchiSteamFarm reference update to ${LATEST_ASF_RELEASE}" + + - name: Push changes to the repo + uses: ad-m/github-push-action@v0.8.0 + with: + github_token: ${{ env.PUSH_GITHUB_TOKEN }} + branch: ${{ github.ref }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..696af65 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,39 @@ +name: Plugin-ci + +on: [push, pull_request] + +env: + DOTNET_CLI_TELEMETRY_OPTOUT: true + DOTNET_NOLOGO: true + DOTNET_SDK_VERSION: 8.0 + +permissions: + contents: read + +jobs: + main: + strategy: + fail-fast: false + matrix: + configuration: [Debug, Release] + os: [macos-latest, ubuntu-latest, windows-latest] + + runs-on: ${{ matrix.os }} + + steps: + - name: Checkout code + uses: actions/checkout@v4.1.7 + with: + show-progress: false + submodules: recursive + + - name: Setup .NET Core + uses: actions/setup-dotnet@v4.0.1 + with: + dotnet-version: ${{ env.DOTNET_SDK_VERSION }} + + - name: Verify .NET Core + run: dotnet --info + + - name: Build ${{ matrix.configuration }} + run: dotnet build -c "${{ matrix.configuration }}" -p:ContinuousIntegrationBuild=true -p:UseAppHost=false --nologo diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..6eb4904 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,204 @@ +name: Plugin-publish + +on: [push, pull_request] + +env: + CONFIGURATION: Release + DOTNET_CLI_TELEMETRY_OPTOUT: true + DOTNET_NOLOGO: true + DOTNET_SDK_VERSION: 8.0 + GPG_PRIVATE_KEY: ${{ secrets.ARCHIBOT_GPG_PRIVATE_KEY }} # Optional, if secret not provided, will skip signing SHA512SUMS with GPG key. You can specify your own credentials if you'd like to, simply change ARCHIBOT_GPG_PRIVATE_KEY here to the one you want to use + +permissions: + contents: read + +jobs: + publish: + strategy: + fail-fast: false + matrix: + os: [macos-latest, ubuntu-latest, windows-latest] + + runs-on: ${{ matrix.os }} + outputs: + PLUGIN_NAME: ${{ steps.plugin-name.outputs.info }} + + steps: + - name: Checkout code + uses: actions/checkout@v4.1.7 + with: + show-progress: false + submodules: recursive + + - name: Parse plugin name from Directory.Build.props + id: plugin-name + uses: mavrosxristoforos/get-xml-info@2.0 + with: + xml-file: 'Directory.Build.props' + xpath: '//PluginName' + + - name: Setup .NET Core + uses: actions/setup-dotnet@v4.0.1 + with: + dotnet-version: ${{ env.DOTNET_SDK_VERSION }} + + - name: Verify .NET Core + run: dotnet --info + + - name: Publish plugin on Unix + if: startsWith(matrix.os, 'macos-') || startsWith(matrix.os, 'ubuntu-') + env: + PLUGIN_NAME: ${{ steps.plugin-name.outputs.info }} + shell: sh + run: | + set -eu + + dotnet publish "$PLUGIN_NAME" -c "$CONFIGURATION" -o "out/plugin/${PLUGIN_NAME}" -p:ContinuousIntegrationBuild=true -p:TargetLatestRuntimePatch=false -p:UseAppHost=false --nologo + + # By default use fastest compression + seven_zip_args="-mx=1" + zip_args="-1" + + # Include extra logic for builds marked for release + case "$GITHUB_REF" in + "refs/tags/"*) + # Tweak compression args for release publishing + seven_zip_args="-mx=9 -mfb=258 -mpass=15" + zip_args="-9" + ;; + esac + + # Create the final zip file + case "$(uname -s)" in + "Darwin") + # We prefer to use zip on OS X as 7z implementation on that OS doesn't handle file permissions (chmod +x) + if command -v zip >/dev/null; then + ( + cd "${GITHUB_WORKSPACE}/out/plugin/${PLUGIN_NAME}" + zip -q -r $zip_args "../../${PLUGIN_NAME}.zip" . + ) + else + 7z a -bd -slp -tzip -mm=Deflate $seven_zip_args "out/${PLUGIN_NAME}.zip" "${GITHUB_WORKSPACE}/out/plugin/${PLUGIN_NAME}/*" + fi + ;; + *) + if command -v 7z >/dev/null; then + 7z a -bd -slp -tzip -mm=Deflate $seven_zip_args "out/${PLUGIN_NAME}.zip" "${GITHUB_WORKSPACE}/out/plugin/${PLUGIN_NAME}/*" + else + ( + cd "${GITHUB_WORKSPACE}/out/plugin/${PLUGIN_NAME}" + zip -q -r $zip_args "../../${PLUGIN_NAME}.zip" . + ) + fi + ;; + esac + + - name: Publish plugin on Windows + if: startsWith(matrix.os, 'windows-') + env: + PLUGIN_NAME: ${{ steps.plugin-name.outputs.info }} + shell: pwsh + run: | + Set-StrictMode -Version Latest + $ErrorActionPreference = 'Stop' + $ProgressPreference = 'SilentlyContinue' + + Set-Location "$env:GITHUB_WORKSPACE" + + dotnet publish "$env:PLUGIN_NAME" -c "$env:CONFIGURATION" -o "out\plugin\$env:PLUGIN_NAME" -p:ContinuousIntegrationBuild=true -p:TargetLatestRuntimePatch=false -p:UseAppHost=false --nologo + + if ($LastExitCode -ne 0) { + throw "Last command failed." + } + + # By default use fastest compression + $compressionArgs = '-mx=1' + + # Include extra logic for builds marked for release + if ($env:GITHUB_REF -like 'refs/tags/*') { + # Tweak compression args for release publishing + $compressionArgs = '-mx=9', '-mfb=258', '-mpass=15' + } + + # Create the final zip file + 7z a -bd -slp -tzip -mm=Deflate $compressionArgs "out\$env:PLUGIN_NAME.zip" "$env:GITHUB_WORKSPACE\out\plugin\$env:PLUGIN_NAME\*" + + if ($LastExitCode -ne 0) { + throw "Last command failed." + } + + - name: Upload plugin artifact + uses: actions/upload-artifact@v4.4.0 + with: + if-no-files-found: error + name: ${{ matrix.os }}_${{ steps.plugin-name.outputs.info }} + path: out/${{ steps.plugin-name.outputs.info }}.zip + + release: + if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') }} + needs: publish + runs-on: ubuntu-latest + + permissions: + contents: write + + steps: + - name: Checkout code + uses: actions/checkout@v4.1.7 + with: + show-progress: false + + - name: Download plugin artifact from ubuntu-latest + uses: actions/download-artifact@v4.1.8 + with: + name: ubuntu-latest_${{ needs.publish.outputs.PLUGIN_NAME }} + path: out + + - name: Import GPG key for signing + uses: crazy-max/ghaction-import-gpg@v6.1.0 + if: ${{ env.GPG_PRIVATE_KEY != null }} + with: + gpg_private_key: ${{ env.GPG_PRIVATE_KEY }} + + - name: Generate SHA-512 checksums and signature + shell: sh + run: | + set -eu + + ( + cd "out" + + sha512sum *.zip > SHA512SUMS + + if [ -n "$GPG_PRIVATE_KEY" ]; then + gpg -a -b -o SHA512SUMS.sign SHA512SUMS + fi + ) + + - name: Upload SHA512SUMS + uses: actions/upload-artifact@v4.4.0 + with: + if-no-files-found: error + name: SHA512SUMS + path: out/SHA512SUMS + + - name: Upload SHA512SUMS.sign + uses: actions/upload-artifact@v4.4.0 + if: ${{ env.GPG_PRIVATE_KEY != null }} + with: + if-no-files-found: error + name: SHA512SUMS.sign + path: out/SHA512SUMS.sign + + - name: Create GitHub release + uses: ncipollo/release-action@v1.14.0 + with: + allowUpdates: true + artifactErrorsFailBuild: true + artifacts: "out/*" + bodyFile: .github/RELEASE_TEMPLATE.md + makeLatest: false + name: ${{ needs.publish.outputs.PLUGIN_NAME }} V${{ github.ref_name }} + prerelease: true + token: ${{ secrets.GITHUB_TOKEN }} + updateOnlyUnreleased: true diff --git a/.github/workflows/update-actions.yml b/.github/workflows/update-actions.yml new file mode 100644 index 0000000..3fb400e --- /dev/null +++ b/.github/workflows/update-actions.yml @@ -0,0 +1,82 @@ +# This action is responsible for automatically updating workflows from ASF-PluginTemplate repo. +# Please note that this WILL OVERWRITE all changes made to default workflows, as well as restore the ones you removed. +# If you plan to edit or remove workflows provided by default - you should remove this file first. +name: Plugin-update-actions + +on: + schedule: + - cron: '20 3 * * *' + + workflow_dispatch: + +env: + # You can specify your own credentials if you'd like to, simply change ARCHIBOT_GPG_PRIVATE_KEY and/or ARCHIBOT_GITHUB_TOKEN secrets here to the ones you want to use + GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }} # Optional, if secret not provided, will skip signing commit with GPG key + PUSH_GITHUB_TOKEN: ${{ secrets.WORKFLOW_TOKEN }} # Optional, if secret not provided, will use the default token + +permissions: + contents: write + actions: write + +jobs: + main: + runs-on: ubuntu-latest + + steps: + - name: Checkout plugin code + uses: actions/checkout@v4.1.7 + with: + show-progress: false + path: plugin + token: ${{ env.PUSH_GITHUB_TOKEN }} + + - name: Checkout template + uses: actions/checkout@v4.1.7 + with: + show-progress: false + repository: JustArchiNET/ASF-PluginTemplate + path: template + token: ${{ env.PUSH_GITHUB_TOKEN }} + + - name: Import GPG key for signing + uses: crazy-max/ghaction-import-gpg@v6.1.0 + if: ${{ env.GPG_PRIVATE_KEY != null }} + with: + gpg_private_key: ${{ env.GPG_PRIVATE_KEY }} + git_user_signingkey: true + git_commit_gpgsign: true + + - name: Update workflows if needed + id: update + shell: sh + run: | + set -eu + + cp -rf template/.github/workflows/*.* plugin/.github/workflows/ + + cd plugin + + if ! git config --get user.email > /dev/null; then + git config --local user.email "action@github.com" + fi + + if ! git config --get user.name > /dev/null; then + git config --local user.name "GitHub Action" + fi + + if [ $(git status --porcelain | wc -c) -ne 0 ]; then + git add -A + git commit -m "Automatic workflows update from ASF-PluginTemplate" + echo "new_commits=true" >> "$GITHUB_OUTPUT" + else + echo "new_commits=false" >> "$GITHUB_OUTPUT" + fi + + + - name: Push changes to the repo + if: ${{ steps.update.outputs.new_commits == 'true'}} + uses: ad-m/github-push-action@v0.8.0 + with: + directory: plugin + github_token: ${{ env.PUSH_GITHUB_TOKEN }} + branch: ${{ github.ref }} diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 0000000..16e8bed --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,42 @@ + + + + + ItemDispenser + 3.0.0.0 + + + + + Rudokhvist + $(Authors) + Copyright © $([System.DateTime]::UtcNow.Year) $(Company) + $(PluginName) + + Apache-2.0 + https://github.com/$(Company)/$(PluginName) + $(PackageProjectUrl)/releases + $(PackageProjectUrl).git + + + + + + false + false + + + + + ../resources/$(PluginName).snk.pub + true + true + + + + + ../resources/$(PluginName).snk + false + true + + diff --git a/Directory.Packages.props b/Directory.Packages.props new file mode 100644 index 0000000..729cff0 --- /dev/null +++ b/Directory.Packages.props @@ -0,0 +1,3 @@ + + +