error with github actions - later resolved

[TimHeckel]

Hey all - love this project! But when using the github actions, I received this error when running the below .github/workflows/build-for-retype.yml action (and I fixed it below):

Error : .github#L1 the 'uses' attribute must be a path, a Docker image, or owner/repo@ref

name: build-for-retype
on:
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  publish:
    name: Publish to the retype branch

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - uses: actions/setup-dotnet@v1
        with:
          dotnet-version: 5.0.x

      - uses: retypeapp/action-build

      - uses: retypeapp/action-github-pages
        with:
          branch: retype
          update-branch: true

Then I noticed the error expected a version number @ref for the repositories in the uses clause, so I added:

     - uses: retypeapp/action-build@v1

      - uses: retypeapp/[email protected]
        with:
          branch: retype
          update-branch: true

And repushed the branch, and it worked (the retype branch was correctly published from the source I pushed). Not sure if this is helpful to others, but thought I'd share.

Thanks!

[fabriciomurta]

Hi! Where did you see a sample telling to use the action without @v1 in the end? We should fix that if that's in any of our documentation.

I just checked https://retype.com/guides/github-actions/ and it shows the right syntax. I'm not sure where you found example suggesting the use without a tag.

We maintain tags in the @v1 and @v1.11 as well as the one you used @v1.11.2 so you don't need to change the action every new release. If you want to stick to latest 1.11, you can use @v1.11, if you want to keep up-to-date as version 1 evolves, using @v1 is the way we recommend using it. Using the exact version tag is only intended when you want to exert strict control of the version being used, if really wary of breaking changes between releases.

[TimHeckel]

thanks for clarifying! Actually I saw the uses without a version in the usage block here.

[fabriciomurta]

We reviewed repo's README to add the @v1 tag with retypeapp/action-github-pages#11. Thanks for the report!

[fabriciomurta]

Oh, and by the way, mixing up tags between the actions (action-build and action-github-pages) should be the very least used scenario and I only see this being the case in some kind of extreme situation where god-knows-what went wrong in a release :)
So you should be using the same tag in both steps. Either action-build@v1 and action-github-pages@v1, or [email protected] and [email protected], not a mixup of each. While it shouldn't really go wrong, it will be much more likely to bring trouble.