Skip to content

RFC: When to do the initial build? #247

Closed
@Westbrook

Description

@Westbrook

Issue

A number of different usage workflows quickly run into the possibility that the repo has not be built (yarn build) by the time that it is needed by an underlying script.

Possible solutions

  1. Just add yarn build after yarn in the README.
    • Is that enough? Do people read READMEs?
    • If we do this, can we take yarn build out from in front of other scripts?
    • Has to possibility of having an out of date build if we remove yarn build from workflows.
  2. Add a post-merge hook to husky that does it for us?
    • Does this run right after clone, do we need to yarn first?
    • Given changes could be incoming, should we yarn anyways?
    • Has to possibility of having an out of date build if we remove yarn build from workflows.
  3. Expand all the scripts to yarn build before hand?
    • Could be done with pre* scripts...
    • Should we layer all scripts to a "user" version and a "ci" version?
  4. Other options?

Notes

I do wish there were less steps to running our code in this repo, however we will need a build command for as long as typescript is as divergent from JS as it is a current. I'll leave moving away from TS for JSDocs based typing as a conversation for another day... 😉

Metadata

Metadata

Assignees

No one assigned

    Labels

    1.0.0Issues that should be addressed for a 1.0 release!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions