jurplel / install-qt-action

Install Qt on your Github Actions workflows with just one simple action
MIT License
446 stars 78 forks source link

v3 docs for aqtversion wrong? #218

Closed pcolby closed 5 months ago

pcolby commented 5 months ago

Hey there, once again, thanks for a super-useful action! ❤️

I might be misunderstanding something, but when I look at the README.md file for all of the v3.* tags, as well as the v3 branch, I see:

aqtversion

... Default: ==3.1.*

Yet, for those same refs, I see in action.yml:

  aqtversion:
    description: ...
    default: ==2.1.*

And when I use jurplel/install-qt-action@v3, it uses aqt v2.1.0, so I think the docs are wrong for v3?

Similarly, the v3 docs claim to support an add-tools-to-path option, but this does not seem to exist in the v3 action.yml either.

Cheers.

pzhlkj6612 commented 5 months ago

Hi!

I guess the "v3 docs" you mentioned is the docs at the "master" branch: https://github.com/jurplel/install-qt-action/blob/f769d0f6b523d021b3e7b2b901a8e32c44d628b7/README.md#add-tools-to-path . The v3 branch, unfortunately, has not been sync-ed with the master branch.


@jurplel , what's the status of those branches? Is there something we can help?

pcolby commented 5 months ago

@pzhlkj6612 wrote:

I guess the "v3 docs" you mentioned is the docs at the "master" branch

Nah, I mean the README.md from the v3 branch and the v3.* tags does not match the action.yml from the same v3 branch and v3.* tags. ie

The master branch matches itself 🙂 Assuming I'm understanding it right, it would be nice to at least get it corrected in v3.3.1, or whatever the next release is 🙂

pzhlkj6612 commented 5 months ago

Nah, I mean the README.md from the v3 branch and the v3.* tags does not match the action.yml from the same v3 branch and v3.* tags. ie

...

Well, I saw ==2.1.* in each pages you linked. For example, the newest commit on the v3 branch is 727bfe75193759a6fe1ca38c6d3f0bcfa68dada8 :

https://github.com/jurplel/install-qt-action/blob/727bfe75193759a6fe1ca38c6d3f0bcfa68dada8/README.md?plain=1#L213-L217

https://github.com/jurplel/install-qt-action/blob/727bfe75193759a6fe1ca38c6d3f0bcfa68dada8/action.yml#L51-L53

Maybe I didn't understand. More details?

The README on the homepage of this repository is at the master branch, BTW.

pcolby commented 5 months ago

Oh, how weird! Ok, it's either a GitHub bug, or something I don't get about GitHub :(

Compare these two:

They show two (slightly) different README.md contents, even though they are the same git ref 😳

image

vs

image

I've never seen this happen on GitHub before, but then I've never looked for it either. Interesting.... Just checked a couple of my own repos, and GitHub doesn't do this for any I checked. I checked a different browser, and incognito session. Must be something a bit messy with GitHub's CDN 🤷🏼‍♂️

Either way, not an install-qt-action issue, but something else, so I think we can close this one. Thanks 😊

pzhlkj6612 commented 5 months ago

Yes. By using web browser's devtools, I saw the https://github.com/jurplel/install-qt-action/tree/v3 page requested the https://github.com/jurplel/install-qt-action/overview-files file containing the following data:

{
    "files": [
        {
            "displayName": "README.md",
            "repoName": "install-qt-action",
            "refName": "master",
            "path": "README.md",
            "preferredFileType": "readme",
            "tabName": "README",
            ...

Please note the "master" refName.