Fix: ktlint not found error

[wf9a5m75]

problem

This PR effort

[ghaiszaher]

@wf9a5m75 can you explain when the issue happens? This line was introduced in #33 to solve the same failure you're mentioning. Without a token, a different rate limit is applied and if many requests are performed from the same IP, you will soon reach that limit.

[wf9a5m75]

Oh I see. In that case, why don't you implement cache for limited time?
KtLint updates once in a while (I believe they don't update every day).
But this action checks every time.
I think once a day is enough.
(But I don't know the external action can create cache)

---

This error occurs you for got the backslash before line-end (\n), thus the pipe does not work.

[ghaiszaher]

Backslash is not needed if the line ends with pipe |. Is it always failing for you when you use ScaCap/action-ktlint?

[wf9a5m75]

Without backslash, always fail.

[ghaiszaher]

@wf9a5m75 coming back to this again, can you replicate this in some public repository so we can take a look?

[wf9a5m75]

Hello again. Sorry for late response. I worked on another projects.
The current version works on pull request. That's great. I appreciate for your work.

However, even the current version does not work on push. Here is the log. Please check the Kotlin linter section.

Actions log
https://github.com/wf9a5m75/WeatherApp/actions/runs/5462654641/jobs/9942305588

- name: Kotlin linter
  # uses: wf9a5m75/action-ktlint@fix_ktlint_not_found  # <-- work on commit
  uses: ScaCap/action-ktlint@master # <-- does not work on commit
  with:
    android: true

https://github.com/wf9a5m75/WeatherApp/blob/1ecb2cc3cb3ce438923136e04dd5e65b0779c0ab/.github/workflows/kotlin-linter_on-commit.yml#L16-L20

---

My PR fixes this issue.

Actions log
https://github.com/wf9a5m75/WeatherApp/actions/runs/5462707377/jobs/9942429736

- name: Kotlin linter
  uses: wf9a5m75/action-ktlint@fix_ktlint_not_found  # <-- work on commit
  # uses: ScaCap/action-ktlint@master # <-- does not work on commit
  with:
    android: true

https://github.com/wf9a5m75/WeatherApp/blob/dc8125fc87ed9c9b58fc7275b00baff4d2fac770/.github/workflows/kotlin-linter_on-commit.yml#L16-L20

[ghaiszaher]

@wf9a5m75 could you try to adjust your workflow with github_token: ${{ secrets.GITHUB_TOKEN }}?

      - name: Kotlin linter
        uses: wf9a5m75/action-ktlint@fix_ktlint_not_found  # <-- work on commit
        # uses: ScaCap/action-ktlint@master # <-- does not work on commit
        with:
          android: true
          github_token: ${{ secrets.GITHUB_TOKEN }}

Also see https://github.com/ScaCap/action-ktlint#github_token and https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow

[zipizigi]

I also found the same problem.
This problem probably doesn't happen on public github.

It happens on Github Enterprise.

curl -sSL https://api.github.com/repos/pinterest/ktlint/releases/latest --header "authorization: Bearer ${INPUT_GITHUB_TOKEN}" |

If you are a Github enterprise user, the 'INPUT_GITHUB_TOKEN' token generated by Github Enterpris cannot be used on public Github.
Therefore authentication fails and ktlint cannot be downloaded.

In this case, if you specify the ktlint version, ktlint is downloaded and the action is available.

- name: Kotlin linter
  uses: ScaCap/action-ktlint@master 
  with:
      github_token: ${{ secrets.github_token }}
      ktlint_version: 0.50.0

[ghaiszaher]

I also found the same problem. This problem probably doesn't happen on public github.

It happens on Github Enterprise.

curl -sSL https://api.github.com/repos/pinterest/ktlint/releases/latest --header "authorization: Bearer ${INPUT_GITHUB_TOKEN}" |

If you are a Github enterprise user, the 'INPUT_GITHUB_TOKEN' token generated by Github Enterpris cannot be used on public Github. Therefore authentication fails and ktlint cannot be downloaded.

In this case, if you specify the ktlint version, ktlint is downloaded and the action is available.

- name: Kotlin linter
  uses: ScaCap/action-ktlint@master 
  with:
      github_token: ${{ secrets.github_token }}
      ktlint_version: 0.50.0

Thank you @zipizigi , you also made me realise that I missed the INPUT_GITHUB_TOKEN when a version is specified.

I don't have experience with GitHub Enterprise. The main purpose of adding this token is to avoid issues related to rate limiting set by GitHub. Without it, the IP might be blocked because of too many requests (the limit is very low there): https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limits-for-requests-from-personal-accounts

For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the person making requests.

I guess we could add a separate flag anyway to instruct the action to just drop the token when downloading but you might still run in issues if many workflows run at the same time. Let me know if you have a better solution for GitHub Enterprise (e.g. another token that is not blocked).

[zipizigi]

It is most accurate to use the api for the download URL.
However, you can use curl and awk to infer the version.
https://github.com/pinterest/ktlint/releases/latest --(redirect)--> https://github.com/pinterest/ktlint/releases/0.50.0.

Among the environment variables provided in Github Enterprise, there are no variables used for public Github authentication.

Therefore, it is better to change the method of specifying the version as above, or Github Enterprise users need to specify a version when running the action.

[ghaiszaher]

It is most accurate to use the api for the download URL. However, you can use curl and awk to infer the version. https://github.com/pinterest/ktlint/releases/latest --(redirect)--> https://github.com/pinterest/ktlint/releases/0.50.0.

Among the environment variables provided in Github Enterprise, there are no variables used for public Github authentication.

Therefore, it is better to change the method of specifying the version as above, or Github Enterprise users need to specify a version when running the action.

Thanks, I'll consider it and see if it's an easy change.

[ghaiszaher]

It is most accurate to use the api for the download URL. However, you can use curl and awk to infer the version. https://github.com/pinterest/ktlint/releases/latest --(redirect)--> https://github.com/pinterest/ktlint/releases/0.50.0.
Among the environment variables provided in Github Enterprise, there are no variables used for public Github authentication.
Therefore, it is better to change the method of specifying the version as above, or Github Enterprise users need to specify a version when running the action.

Thanks, I'll consider it and see if it's an easy change.

Thanks to this answer: https://stackoverflow.com/a/54836319, I figured that latest can be used in the download URL instead of the version number but only if it switches places with download, so:

• https://github.com/pinterest/ktlint/releases/download/0.50.0/ktlint (specific version)
• https://github.com/pinterest/ktlint/releases/latest/download/ktlint (latest version)

I'll raise a separate PR.

[ghaiszaher]

Here we go: #45

[ghaiszaher]

@zipizigi @wf9a5m75 please open an issue if the problem persists