Reset PATH environment variable

[rsenden]

Select Topic Area

Question

Body

I have a composite action that invokes a tool that requires Java 17, but potentially the invoking workflow may be using a different Java version. As such, I'd like my composite action to do something like this:

1. Store original JAVA_HOME and PATH
2. Call actions/setup-java
3. Store new value of JAVA_HOME in a TOOL_JAVA_HOME environment variable, to be used later to invoke the tool
4. Restore original JAVA_HOME and PATH from step 1

Restoring JAVA_HOME is easy, but my attempts to restore PATH have failed so far; echo "PATH=${ORG_PATH}" >> $GITHUB_ENV doesn't seem to update the PATH, and echo "${ORG_PATH}" >> $GITHUB_PATH duplicates the path entries.

Some alternative approaches that came to mind:

1. Ideally, actions/setup-java should allow for setting up a given Java version/distribution but without setting any environment variables; subsequent steps could access Java path through ${{ steps.setup_java_step.outputs.path }}. Is there any way to prevent setup-java from setting any environment variables?
2. I could just take the value of JAVA_HOME_17_X64, which is available by default on GitHub-hosted runners, however this may not be available on self-hosted runners and potentially I'd need to check the runner architecture to select the correct environment variable name (for now we only support X64, but eventually we want to support arm64 as well)
3. I could just do echo "${ORG_JAVA_HOME}/bin" >> $GITHUB_PATH to have the original Java version first on the PATH again

Any better approaches for accomplishing this? Unless we can somehow accomplish approach 1, I guess approach 3 is the best work-around? Note that we need to support Linux, Windows & Mac runners, both GitHub-hosted & self-hosted.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬