Github actions for scoop buckets

Set of automated actions you will ever need as bucket maintainer. Using stable tag instead of specific version is highly recommended.

Implemented actions

Excavator (Excavator | Excavate)

• ❗❗❗ Protected master branches are not supported ❗❗❗
• Periodically execute automatic updates for all manifests
• Refer to help page for configuration formats
• https://github.com/ScoopInstaller/Excavator alternative
  • If you do not have custom server / device which could run docker or scheduled task for auto-pr 24/7

Issues (Issues | IssueHandler)

As soon as new issue is created or label verify is added action is executed. Based on issue title specific sub-action is executed. It could be one of these:

• Hash check fails
  1. Checkhashes binary is executed
  2. Result is parsed
     1. Hash mismatch
        1. Pull requests with name <manifest>@<version>: Hash fix are listed
           1. There is PR already
              1. The newest one is selected
              2. Description of this PR is updated with closing directive for created issue
              3. Comment to issue is posted with reference to PR
           2. If none
              1. New branch <manifest>-hash-fix-<random> is created
              2. Changes are commited
              3. New PR is created from this branch
        2. Labels hash-fix-needed, verified are added
     2. No problem
        1. Comment on issue is posted about hashes being right
        2. Label hash-fix-needed is removed
        3. Issue is closed
     3. Binary error
        1. Label package-fix-needed is added
• Download failed
  1. All urls defined in manifest are retrieved
  2. Downloading of all urls is executed
  3. Comment will be posted to issue
     1. If there is problematic URL
        1. List of problematic URLs is attached in comment
        2. Labels package-fix-needed, verified, help-wanted is added
     2. All URLs could be downloaded without problem
        1. Possible causes of download problems are attached in comment

Pull requests (Pull requests | PullRequestHandler)

As soon as PR is created (or someone post comment /verify) set of these tests are executed:

• ❗❗ Pull request created from forked repository cannot be finished due to different permission scope of token ❗❗
  • Manual /verify comment is needed

1. Required properties are in place
   • Manifest has to contain License and Description properties
2. Hashes of URLs
   • Hashes specified in manifest have to match
3. Checkver functionality
   • Checkver has to finished successfully
   • Version in manifest has to match version from checkver binary
4. Autoupdate
   • Autoupdate has to finish successfully
   • Hashes extraction has to finish successfully
     • If there is hash property inside autoupdate output of checkver binary cannot contains Could not find hash

• All checks could be executed with /verify comment. (Ash258/GithubActionsBucketForTesting#176)

Example workflows for everything you will ever need as bucket maintainer

#.github\workflows\schedule.yml
on:
  schedule:
  - cron: '*/30 * * * *'
name: Excavator
jobs:
  excavate:
    name: Excavate
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Excavate
      uses: Ash258/Scoop-GithubActions@stable
      env:
        GITH_EMAIL: youremail@mail.com
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        SKIP_UPDATED: '1'

#.github\workflows\issues.yml
on:
  issues:
    types: [opened, labeled]
name: Issues
jobs:
  issueHandler:
    name: IssueHandler
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: IssueHandler
      uses: Ash258/Scoop-GithubActions@stable
      if: github.event.action == 'opened' || (github.event.action == 'labeled' && contains(github.event.issue.labels.*.name, 'verify'))
      env:
        GITH_EMAIL: youremail@mail.com
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

#.github\workflows\issue_commented.yml
on:
  issue_comment:
    types: [created]
name: Pull requests comment
jobs:
  pullRequestHandler:
    name: PullRequestHandler
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: PullRequestHandler
      uses: Ash258/Scoop-GithubActions@stable
      if: startsWith(github.event.comment.body, '/verify')
      env:
        GITH_EMAIL: youremail@mail.com
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

#.github\workflows\pull_request.yml
on:
  pull_request:
    types: [opened]
name: Pull requests
jobs:
  pullRequestHandler:
    name: PullRequestHandler
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: PullRequestHandler
      uses: Ash258/Scoop-GithubActions@stable
      env:
        GITH_EMAIL: youremail@mail.com
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

How to debug locally

# LocalTestEnvironment.ps1

# Try to avoid all real requests into real repository
#    All events inside repository will use GithubActionsBucketForTesting repository for testing purpose
[System.Environment]::SetEnvironmentVariable('GITHUB_TOKEN', '<yourtoken>', 'Process')
[System.Environment]::SetEnvironmentVariable('GITHUB_EVENT_NAME', '<EVENT YOU WANT TO DEBUG>', 'Process')
# Create Cosi.json with any request from events folder
[System.Environment]::SetEnvironmentVariable('GITHUB_EVENT_PATH', "$PSScriptRoot\cosi.json", 'Process')
[System.Environment]::SetEnvironmentVariable('GITHUB_REPOSITORY', 'Ash258/GithubActionsBucketForTesting', 'Process')
$DebugPreference = 'Continue'
git clone 'https://github.com/Ash258/GithubActionsBucketForTesting.git' '/github/workspace'
# Uncomment debug entries in Dockerfile

Execute docker run -ti (((docker build -q .) -split ':')[1]) or docker build . -t 'actions:master'; docker run -ti actions.