From a45541f0b98c95e5b5da7ae5b46fdfc582329ab2 Mon Sep 17 00:00:00 2001 From: Aetherinox Date: Mon, 17 Mar 2025 18:49:10 -0700 Subject: [PATCH] ci: update workflow commenting --- .github/workflows/deploy-clean.yml | 61 +++++++++++++------ .github/workflows/deploy-docker-all.yml | 35 ++++++++--- .github/workflows/deploy-docker-dockerhub.yml | 35 ++++++++--- .github/workflows/deploy-docker-gitea.yml | 35 ++++++++--- .github/workflows/deploy-docker-giteacom.yml | 32 ++++++++-- .github/workflows/deploy-docker-github.yml | 35 ++++++++--- .github/workflows/issues-scan.yml | 40 +++++++++--- 7 files changed, 211 insertions(+), 62 deletions(-) diff --git a/.github/workflows/deploy-clean.yml b/.github/workflows/deploy-clean.yml index f5fba0d8..79af9354 100755 --- a/.github/workflows/deploy-clean.yml +++ b/.github/workflows/deploy-clean.yml @@ -1,15 +1,35 @@ # # # @type github workflow -# @desc cleans up the list of deployments in the environment history -# edit the 'environment:' to determine which deployment to keep clean -# - can be ran manually # @author Aetherinox # @url https://github.com/Aetherinox +# @usage cleans up the list of deployments in the environment history +# edit the 'environment:' to determine which deployment to keep clean +# - can be ran manually # -# @secrets secrets.SELF_TOKEN_CL Github Access Token (Classic) -# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKfLOWS Discord Webbhook URL; right-click on channel, click "Integrations" -# # - +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: +# git pull https://github.com/username/repo +# act -W .github/workflows/deploy-clean.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 +# act -W .github/workflows/deploy-clean.yml -s TOKEN_CL=XXXXXXXXXX --pull=false # # name: "⚙️ Deploy › Clean" @@ -30,10 +50,10 @@ on: # # DEPLOYMENT_ENV: - description: '📦 Deployment Environment' - required: true - default: 'orion' - type: string + description: '📦 Deployment Environment' + required: true + default: 'orion' + type: string # # # Delay @@ -42,20 +62,22 @@ on: # # DEPLOYMENT_DELAY: - description: '🕛 Delete Delay' - required: true - default: '1000' - type: string + description: '🕛 Delete Delay' + required: true + default: '1000' + type: string # # # environment variables # # env: - DEPLOYMENT_ENV: ${{ github.event.inputs.DEPLOYMENT_ENV || 'orion' }} - DEPLOYMENT_DELAY: ${{ github.event.inputs.DEPLOYMENT_DELAY || '1000' }} - BOT_NAME_1: EuropaServ - BOT_NAME_DEPENDABOT: dependabot[bot] + DEPLOYMENT_ENV: ${{ github.event.inputs.DEPLOYMENT_ENV || 'orion' }} + DEPLOYMENT_DELAY: ${{ github.event.inputs.DEPLOYMENT_DELAY || '1000' }} + BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ + BOT_NAME_DEPENDABOT: dependabot[bot] + BOT_NAME_RENOVATE: renovate[bot] LABELS_JSON: | [ { "name": "AC › Changes Made", "color": "8F1784", "description": "Requested changes have been made and are pending a re-scan" }, @@ -128,7 +150,6 @@ jobs: runs-on: apollo-x64 timeout-minutes: 20 permissions: write-all - steps: # # diff --git a/.github/workflows/deploy-docker-all.yml b/.github/workflows/deploy-docker-all.yml index bd88033b..73e55b02 100755 --- a/.github/workflows/deploy-docker-all.yml +++ b/.github/workflows/deploy-docker-all.yml @@ -4,13 +4,31 @@ # @url https://github.com/Aetherinox # @usage deploys docker container to github, gitea, and dockerhub and send message to discord # upload this workflow to both the `main` branch of the tvapp2 repository -# @secrets secrets.ADMINSERV_GPG_KEY_ASC gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK -# secrets.ADMINSERV_GPG_PASSPHRASE gpg private key passphrase -# secrets.ORG_BINARYNINJA_TOKEN github personal access token (fine-grained) -# secrets.ORG_BINARYNINJA_TOKEN_CL github personal access token (classic) -# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN dockerhub secret -# secrets.ORG_BINARYNINJA_GITEA_TOKEN gitea personal access token (classic) with package:write permission -# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report releases from github to discord +# +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: +# git pull https://github.com/username/repo +# act -W .github/workflows/deploy-docker-all.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 +# act -W .github/workflows/deploy-docker-all.yml -s TOKEN_CL=XXXXXXXXXX --pull=false # # name: "📦 Deploy › Docker › All" @@ -189,8 +207,11 @@ env: IMAGE_GITEA_AUTHOR: ${{ github.event.inputs.IMAGE_GITEA_AUTHOR || 'BinaryNinja' }} IMAGE_GITEA_USERNAME: ${{ github.event.inputs.IMAGE_GITEA_USERNAME || 'BinaryNinja' }} IMAGE_GITEA_WEBSITE: ${{ github.event.inputs.IMAGE_GITEA_WEBSITE || 'git.binaryninja.net' }} + BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ BOT_NAME_DEPENDABOT: dependabot[bot] + BOT_NAME_RENOVATE: renovate[bot] # # # Jobs diff --git a/.github/workflows/deploy-docker-dockerhub.yml b/.github/workflows/deploy-docker-dockerhub.yml index ce5f414b..80d714f6 100755 --- a/.github/workflows/deploy-docker-dockerhub.yml +++ b/.github/workflows/deploy-docker-dockerhub.yml @@ -4,13 +4,31 @@ # @url https://github.com/Aetherinox # @usage deploys docker container to Dockerhub and send message to discord # upload this workflow to both the `main` branch of the tvapp2 repository -# @secrets secrets.ADMINSERV_GPG_KEY_ASC gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK -# secrets.ADMINSERV_GPG_PASSPHRASE gpg private key passphrase -# secrets.ORG_BINARYNINJA_TOKEN github personal access token (fine-grained) -# secrets.ORG_BINARYNINJA_TOKEN_CL github personal access token (classic) -# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN dockerhub secret -# secrets.ORG_BINARYNINJA_GITEA_TOKEN gitea personal access token (classic) with package:write permission -# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report releases from github to discord +# +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: +# git pull https://github.com/username/repo +# act -W .github/workflows/deploy-docker-dockerhub.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 +# act -W .github/workflows/deploy-docker-dockerhub.yml -s TOKEN_CL=XXXXXXXXXX --pull=false # # name: "📦 Deploy › Docker › Dockerhub" @@ -121,8 +139,11 @@ env: IMAGE_VERSION: ${{ github.event.inputs.IMAGE_VERSION || '1.0.0' }} IMAGE_DOCKERHUB_AUTHOR: ${{ github.event.inputs.IMAGE_DOCKERHUB_AUTHOR || 'thebinaryninja' }} IMAGE_DOCKERHUB_USERNAME: ${{ github.event.inputs.IMAGE_DOCKERHUB_USERNAME || 'thebinaryninja' }} + BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ BOT_NAME_DEPENDABOT: dependabot[bot] + BOT_NAME_RENOVATE: renovate[bot] # # # Jobs diff --git a/.github/workflows/deploy-docker-gitea.yml b/.github/workflows/deploy-docker-gitea.yml index a442b144..9c0cd03a 100755 --- a/.github/workflows/deploy-docker-gitea.yml +++ b/.github/workflows/deploy-docker-gitea.yml @@ -4,13 +4,31 @@ # @url https://github.com/Aetherinox # @usage deploys docker container to Gitea and send message to discord # upload this workflow to both the `main` branch of the tvapp2 repository -# @secrets secrets.ADMINSERV_GPG_KEY_ASC gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK -# secrets.ADMINSERV_GPG_PASSPHRASE gpg private key passphrase -# secrets.ORG_BINARYNINJA_TOKEN github personal access token (fine-grained) -# secrets.ORG_BINARYNINJA_TOKEN_CL github personal access token (classic) -# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN dockerhub secret -# secrets.ORG_BINARYNINJA_GITEA_TOKEN gitea personal access token (classic) with package:write permission -# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report releases from github to discord +# +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: +# git pull https://github.com/username/repo +# act -W .github/workflows/deploy-docker-gitea.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 +# act -W .github/workflows/deploy-docker-gitea.yml -s TOKEN_CL=XXXXXXXXXX --pull=false # # name: "📦 Deploy › Docker › Gitea" @@ -133,8 +151,11 @@ env: IMAGE_GITEA_AUTHOR: ${{ github.event.inputs.IMAGE_GITEA_AUTHOR || 'BinaryNinja' }} IMAGE_GITEA_USERNAME: ${{ github.event.inputs.IMAGE_GITEA_USERNAME || 'BinaryNinja' }} IMAGE_GITEA_WEBSITE: ${{ github.event.inputs.IMAGE_GITEA_WEBSITE || 'git.binaryninja.net' }} + BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ BOT_NAME_DEPENDABOT: dependabot[bot] + BOT_NAME_RENOVATE: renovate[bot] # # # Jobs diff --git a/.github/workflows/deploy-docker-giteacom.yml b/.github/workflows/deploy-docker-giteacom.yml index 7bf01b91..a3fa6ff5 100644 --- a/.github/workflows/deploy-docker-giteacom.yml +++ b/.github/workflows/deploy-docker-giteacom.yml @@ -4,10 +4,31 @@ # @url https://github.com/Aetherinox # @usage deploys docker container to Gitea.com and send message to discord # upload this workflow to both the `main` branch of the tvapp2 repository -# @secrets secrets.ADMINSERV_GPG_KEY_ASC gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK -# secrets.ADMINSERV_GPG_PASSPHRASE gpg private key passphrase -# secrets.ORG_BINARYNINJA_GITEACOM_TOKEN gitea.com personal access token (classic) with package:write permission -# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES Discord webhook to report releases from gitea to discord +# +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: +# git pull https://github.com/username/repo +# act -W .github/workflows/deploy-docker-giteacom.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 +# act -W .github/workflows/deploy-docker-giteacom.yml -s TOKEN_CL=XXXXXXXXXX --pull=false # # name: "📦 Deploy › Docker › Gitea.com" @@ -130,8 +151,11 @@ env: IMAGE_GITEA_AUTHOR: ${{ github.event.inputs.IMAGE_GITEA_AUTHOR || 'BinaryNinja' }} IMAGE_GITEA_USERNAME: ${{ github.event.inputs.IMAGE_GITEA_USERNAME || 'BinaryNinja' }} IMAGE_GITEA_WEBSITE: ${{ github.event.inputs.IMAGE_GITEA_WEBSITE || 'gitea.com' }} + BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ BOT_NAME_DEPENDABOT: dependabot[bot] + BOT_NAME_RENOVATE: renovate[bot] # # # Jobs diff --git a/.github/workflows/deploy-docker-github.yml b/.github/workflows/deploy-docker-github.yml index 8b2e12b6..d895a741 100755 --- a/.github/workflows/deploy-docker-github.yml +++ b/.github/workflows/deploy-docker-github.yml @@ -4,13 +4,31 @@ # @url https://github.com/Aetherinox # @usage deploys docker container to github and send message to discord # upload this workflow to both the `main` branch of the tvapp2 repository -# @secrets secrets.ADMINSERV_GPG_KEY_ASC gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK -# secrets.ADMINSERV_GPG_PASSPHRASE gpg private key passphrase -# secrets.ORG_BINARYNINJA_TOKEN github personal access token (fine-grained) -# secrets.ORG_BINARYNINJA_TOKEN_CL github personal access token (classic) -# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN dockerhub secret -# secrets.ORG_BINARYNINJA_GITEA_TOKEN gitea personal access token (classic) with package:write permission -# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report releases from github to discord +# +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: +# git pull https://github.com/username/repo +# act -W .github/workflows/deploy-docker-github.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 +# act -W .github/workflows/deploy-docker-github.yml -s TOKEN_CL=XXXXXXXXXX --pull=false # # name: "📦 Deploy › Docker › Github" @@ -120,8 +138,11 @@ env: IMAGE_VERSION: ${{ github.event.inputs.IMAGE_VERSION || '1.0.0' }} IMAGE_GHCR_AUTHOR: ${{ github.event.inputs.IMAGE_GHCR_AUTHOR || 'BinaryNinja' }} IMAGE_GHCR_USERNAME: ${{ github.event.inputs.IMAGE_GHCR_USERNAME || 'BinaryNinja' }} + BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ BOT_NAME_DEPENDABOT: dependabot[bot] + BOT_NAME_RENOVATE: renovate[bot] # # # Jobs diff --git a/.github/workflows/issues-scan.yml b/.github/workflows/issues-scan.yml index f5f92dab..83c010a2 100755 --- a/.github/workflows/issues-scan.yml +++ b/.github/workflows/issues-scan.yml @@ -1,20 +1,39 @@ # # # @type github workflow -# @desc pull request autoscan +# @author Aetherinox +# @url https://github.com/Aetherinox +# @desc pull request auto-scan # scans all of the files related to a particular pull request # if the code in the files being submitted contains code that is forbidden, # a report is generated and posted as a comment in the PR. # sends notifications to discord using webhooks # -# can be tested using act: -# - https://github.com/nektos/act -# command: +# @notes skips title changes if the author of the PR is renovate[bat] +# +# @secrets secrets.SELF_TOKEN self github personal access token (fine-grained) +# secrets.SELF_TOKEN_CL self github personal access token (classic) +# secrets.NPM_TOKEN self npmjs access token +# secrets.PYPI_API_TOKEN self Pypi API token (production site) - https://pypi.org/ +# secrets.PYPI_API_TEST_TOKEN self Pypi API token (test site) - https://test.pypi.org/ +# secrets.SELF_DOCKERHUB_TOKEN self Dockerhub token +# secrets.ORG_BINARYNINJA_TOKEN org github personal access token (fine-grained) +# secrets.ORG_BINARYNINJA_TOKEN_CL org github personal access token (classic) +# secrets.ORG_BINARYNINJA_DOCKERHUB_TOKEN org dockerhub secret +# secrets.ORG_BINARYNINJA_GITEA_TOKEN org gitea personal access token (classic) with package:write permission +# secrets.BINARYSERV_GPG_KEY_ASC bot gpg private key (armored) | BEGIN PGP PRIVATE KEY BLOCK +# secrets.BINARYSERV_GPG_PASSPHRASE bot gpg private key passphrase +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_RELEASES discord webhook to report release notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_WORKFLOWS discord webhook to report workflow notifications from github to discord +# secrets.DISCORD_WEBHOOK_CHAN_GITHUB_TVAPP2_UPDATES discord webhook to report activity notifications from github to discord +# +# @local these workflows can be tested locally through the use of `act` +# https://github.com/nektos/act +# Extract act to folder +# Add system env var with path to act.exe +# Run the commands: # git pull https://github.com/username/repo # act -W .github/workflows/issues-scan.yml -P ubuntu-latest=catthehacker/ubuntu:full-22.04 # act -W .github/workflows/issues-scan.yml -s TOKEN_CL=XXXXXXXXXX --pull=false -# -# @author Aetherinox -# @url https://github.com/Aetherinox # # name: "🎫 Issues › Scan" @@ -47,6 +66,7 @@ env: LABEL_TYPE_GITACTION: Type ◦ Git Action BOT_NAME_1: EuropaServ + BOT_NAME_2: BinaryServ BOT_NAME_DEPENDABOT: dependabot[bot] BOT_NAME_RENOVATE: renovate[bot] @@ -119,14 +139,14 @@ env: jobs: # # - # Job [ Autoscan ] + # Job › Autoscan # # job-pr-autoscan: name: 🎫 Issues › Autoscan # runs-on: ubuntu-latest - runs-on: ubuntu-latest - timeout-minutes: 10 + runs-on: apollo-x64 + timeout-minutes: 7 permissions: contents: read actions: read