andgate/coolscript

Untyped scripting language

Hi there 👋

coolscript's Issues

Add README.md files to individual projects

Add README.md files to individual projects, for npmjs.org

Disallow merging pull-requests which fail CI testing

Pull-requests must pass the Test workflow to have merge access.

Enhanced dev workflow with nx

Integrate NX into the monorepo to speed up dev workflow. In particular, the pnpm start script would be much faster if libraries were build in order, but in watch-mode. pnpm doesn't seem capable of doing this on its own. However, nx projects have enough structure to accomplish this. Look into integrating NX with pnpm and re-configuring the project to allow this behavior.

Use gh-pages npm package

Use gh-pages npm package to create a cleaner gh-pages branch, and simplify the docs workflow.

Reference:

• https://www.npmjs.com/package/gh-pages

Publish new package versions using changesets

Should publish new package versions using changesets.

Resources

• https://github.com/changesets/action
• https://pnpm.io/using-changesets

pnpm install is not cached

Ensure workflows has PNPM caching setup properly.
See for more details: https://pnpm.io/continuous-integration#github-actions

Publishing steps not documented.

Document the steps to publish packages in the root README.

Automate Building Static Website

Currently, the static website for coolscript must be manually built and pushed during every PR. This means that a copy of the website is maintained on every branch, including main. Using github workflows, isolate the build to a specific branch, which is triggered by pushing to to main and rebuilds the website in a docs folder. Most docs workflows commit these changes to a gh-pages branch, so we should use that one.

Release workflow should tag new releases

Would be nice if the release workflow would create tags as new releases are produced.

Automated docs pipeline should abort on no changes

Automated docs pipeline should abort on no changes. Currently, there is an error if rebuilding docs introduces no changes. This behavior is not ideal, and produce false-red flags.

Automate Publishing with Changeset

Publishing should be automated with changeset