8000 Discrepancy in the documentation · Issue #464 · actions/setup-python · GitHub
[go: up one dir, main page]
Skip to content

Discrepancy in the documentation #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
dsame opened this issue Jul 15, 2022 · 3 comments 8000
Closed

Discrepancy in the documentation #464

dsame opened this issue Jul 15, 2022 · 3 comments
Assignees
@dsame
Labels
bug Something isn't working

Comments

@dsame
Copy link
Contributor
dsame commented Jul 15, 2022

Description:

README says : "The Python packages ... are originally compiled from source in /opt/hostedtoolcache/ ... which makes them non-relocatable."

But instruction to setup tool cache on self-hosted runners without internet access mentions "RUNNER_DIR/_work/_tool"

This leads to the confusion, see the discussion of #459
@dsame dsame added bug Something isn't working needs triage and removed needs triage labels Jul 15, 2022
@dsame dsame self-assigned this Jul 15, 2022
@dsame dsame mentioned this issue Jul 15, 2022
Closed
5 tasks
@techman83
Copy link
Contributor

Hi @dsame - I've done a bit of digging. When this documentation was written, it was likely based on the implementation within actions/python-versions at the time. However shortly before this change was made to the docs, the code for Linux/Mac aligned with the windows self-hosted experience.

#394 was introduced to align the implementation with the documentation. This is a good thing, however the documentation doesn't reflect how actions/python-versions works now. The upstream now uses RUNNER_TOOL_CACHE if AGENT_TOOLSDIRECTORY is not set. The implementation in #394 overwrites RUNNER_TOOL_CACHE to the path that is the default (/opt/hostedtoolcache) for hosted runners. However self-hosted runners use a configurable relative path, provided during launch of the runner.

I realise I am being pedantic in relation to something that breaks my use case, however I feel strongly that the better technical outcome would be that users of self-hosted runners get a consistent experience compared to hosted, and it is what I attempted in #461. The added bonus is that the behaviour in that PR for users of the hosted runners is identical with or without my change, whilst also simplifying the self-hosted experience in the process.

@techman83
Copy link
Contributor

The initial issue has been resolved and the documentation for macOS improved to be clear about the issue. So this can probably be closed.

@IvanZosimov
Copy link
Contributor

I agree with @techman83 and think that this issue can be closed because this discrepancy appears only for python binaries on macOS self-hosted runners and this fact is mentioned in the documentation for setup-python.

By now I'm going to close this issue, If you have any additional questions, please, feel free to ping us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dsame dsame

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dsame @techman83 @IvanZosimov
0