location input confusing

Open
#422 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, javascript
Domain
ci-cd, tooling

Research direction

Review how the location input is documented and how installer archives with a top-level msys64 directory are extracted. Resolve whether the intended outcome is clearer documentation or a separate real-installation-path input, then verify that the chosen behavior matches the setup-msys2 action's archive handling.

Written by the indexing model from the issue text.

Description

location is currently used as the parent dir of the installation, so the files will end up in <location>/msys64. It's not clear to users that this is the case.

This comes from the installer/archives containing a toplevel msys64 dir which is extracted. This might make sense for the archives, but for setup-msys2 this is more of an implementation detail.

  1. We could document the current location better
  2. We could add a new input that specifies the real installation path and deprecate the old one. Not sure how easy that is with the sfx archive though.

Motivated by someone in chat being confused by this.

Dominant language
JavaScript
Stars
392
Forks
52
Avg merge
52m
Merged PRs (30d)
7

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from msys2/setup-msys2

All issues in msys2/setup-msys2

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.