[Bug]: itch.io integration

[RedGlow]

What happened?

I'm trying to deploy the game to itch.io. The task running is:

      - name: 🕹️ Deploy to itch.io
        if: matrix.target == 'itch.io'
        run: |
          if [ -z "${{ secrets.ITCH_USERNAME }}" ] || [ -z "${{ secrets.ITCH_PROJECT }}" ]; then
            echo "⚠️ Missing itch.io credentials."; 
            exit 1;
          fi
          butler push "$ARTIFACT_DIR" "${{ secrets.ITCH_USERNAME }}/${{ secrets.ITCH_PROJECT }}:${{ inputs.buildType }}"
        env:
          BUTLER_API_KEY: ${{ secrets.DEPLOY_API_KEY }}

The error reported is:

Run if [ -z "***" ] || [ -z "***" ]; then
  if [ -z "***" ] || [ -z "***" ]; then
    echo "⚠️ Missing itch.io credentials."; 
    exit 1;
  fi
  butler push "$ARTIFACT_DIR" "***/***:release_candidate"
  shell: /usr/bin/bash -e {0}
  env:
    DEPLOY_DIR: deployment-artifacts
    PROJECT_DIR: Riscrittora-v0.0.5-rc.5
    ARTIFACT_DIR: deployment-artifacts/Riscrittora-v0.0.5-rc.5
    BUTLER_API_KEY: ***
/home/runner/work/_temp/4e8c7f69-cf[2](https://github.com/owof-games/LaRiscrittora/actions/runs/15413131644/job/43370492177#step:11:2)f-48a3-b9c4-f3f2c39bc379.sh: line 5: butler: command not found
Error: Process completed with exit code 127.

I guess the butler executable is not installed in ubuntu-latest. Looking around, probably a simple

      - name: 🤵 Install Butler
        if: matrix.target == 'itch.io'
        uses: remarkablegames/setup-butler@v1

Or analogous setup with another action. I haven't tested this though, but I can try modifying the step-4-deploy.xml, porting it inside the project and correcting all the urls in order to add this step, but before doing it I wanted to check if I'm not missing something.

Steps to reproduce

List the steps:

1. Ran the dispatched pipeline with itch.io and all its build targets on
2. Got this error

Expected behavior

The butler executable to run and try to upload the build.

Workflow details

• Workflow file: step-4-deploy.yml
• Trigger type: workflow_dispatch
• Inputs/parameters used:
  • buildType:
  • deployTargets: ["itch.io"]
  • buildTargets: ["WebGL"]
  • change deploy-targets.json for the itch.io entry like this:

  "itch.io": {
    "os": "ubuntu-latest",
    "requiresCombinedArtifact": false,
    "minimumBuildType": "preview",
    "compatibleBuildTargets": ["WebGL"]
  },

Environment

• Unity version: 6000.1
• OS: Windows 11
• GitHub Runner: ubuntu-latest

[Avalin]

Very likely a bug rather than you having missed anything. (I tested the flow with Github pages only initially, to not overwork myself, so the implementation is experimental and untested, hence this feedback is very valuable). I'll add the butler install to the flow later today, sorry it's been a little while. If you already made it work, you're more than welcome to open a PR or just let me know what's missing 😃

[Avalin]

I changed the use of DEPLOY_API_KEY to BUTLER_API_KEY (it was also used in the appcenter deploy) and added the install:

  - name: 🤵 Install Butler
    if: matrix.target == 'itch.io'
    uses: remarkablegames/setup-butler@v1

  - name: 🕹️ Deploy to itch.io
    if: matrix.target == 'itch.io'
    run: |
      if [ -z "${{ secrets.ITCH_USERNAME }}" ] || [ -z "${{ secrets.ITCH_PROJECT }}" ]; then
        echo "⚠️ Missing itch.io credentials."; 
        exit 1;
      fi
      butler push "$ARTIFACT_DIR" "${{ secrets.ITCH_USERNAME }}/${{ secrets.ITCH_PROJECT }}:${{ inputs.buildType }}"
    env:
      BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}

Hopefully this will make it work. I'll leave the issue open until I've properly tested with an itch.io project; or you can confirm to me that it works. ✨

[RedGlow]

Hello! I'm really sorry for answering so late to this ticket 🙏

I have updated all the scripts (with one caveat, see below, it probably is a different ticket, and in case I can open it). The deploy succeeds, but I think the channel specification is wrong.

What I see in the code is:

      - name: 🕹️ Deploy to itch.io
        if: matrix.target == 'itch.io'
        run: |
          if [ -z "${{ secrets.ITCH_USERNAME }}" ] || [ -z "${{ secrets.ITCH_PROJECT }}" ]; then
            echo "⚠️ Missing itch.io credentials."; 
            exit 1;
          fi
          butler push "$ARTIFACT_DIR" "${{ secrets.ITCH_USERNAME }}/${{ secrets.ITCH_PROJECT }}:${{ inputs.buildType }}"
        env:
          BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}

the butler command uses ${{ inputs.buildType }} as a channel. The content of that input, from what I gathered, is something like release_candidate, release, and so on, whereas it should be the platform, like windows, linux, etc. The end result is something like this:

Also, the butler push command supports a version, so it would probably be the best to send that information too.

---

as for the problem I was mentioning before (and here I'm reconstructing the problem by heart), I noticed that using the latest version of the workflows in CICD_Workflows (the "public" versions) I am receiving errors like this, immediately when I start the workflow:

Invalid workflow file: .github/workflows/ci-cd-dispatcher.yml#L133
The workflow is not valid. .github/workflows/ci-cd-dispatcher.yml (Line: 133, Col: 11): Input runnerMacos is required, but not provided while calling.

I had to take the scripts in the .github directory and update the references to the other workflows by adding repo+directory; moreover, I had to point to @ main versions instead of @ v1 versions, since they seem to be missing these new inputs. If necessary I can try to reproduce this problem with better information.

PS: thanks a lot again for this project, even just reading the code I'm learning tons of stuff about how CI/CD workflows work on GitHub! ;-)

[Avalin]

Oi yes, thanks for reporting this! :D I had hoped I could keep v1 working while fiddling with main, but using github to manage cicd-branches on github can be a bit messy!

Your itch.io PR I've tested, merged, mildly modified and it is now working for me with my test-project, so that should hopefully be solved! ⭐