matrix-org / matrix-org/matrix-analytics-events

Can't publish/build on Windows (easily)

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

Nobody has claimed this yet.

Dominant language
Kotlin
Stars
14
Forks
10
Avg merge
1d 23h
Merged PRs (30d)
1

Description

It's difficult to set this project up on Windows, and npm interactions (particularly after https://github.com/matrix-org/matrix-analytics-events/pull/31 lands for publishing) are near-impossible.

The major points of concern are:

Workaround steps for publishing (post-#31) are:

  1. Use WSL
  2. yarn install
  3. yarn build:ts (run the prepublish script manually)
  4. Go back to the host
  5. Disable prepublishOnly by renaming it
  6. npm publish --access public

It's obviously not great to have to jump around between VMs to do a release though.

Contributor guide

Open the contributing guide

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.

Research direction

Start with the npm scripts behind npm build and yarn build:ts, especially the prepublishOnly path, and trace how ../schemas/*.json and shell scripts are invoked on Windows. Reproduce the failure on Windows and inspect the publishing workaround. Done means build and publish commands work on Windows without manual script renaming or VM/WSL steps, with failures returning correct exit codes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, shell
Domain
build-system, developer-experience, operating-systems, release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.