Files
setup-haskell/docs/contributors.md
jared-w 8154472447 Add Windows and macOS Support (#1)
* Re-base onto upstream master

* Use os over operating-system per json schema suggestion

* Upgrade dependencies

* Update action.yml syntax

* Restructure repo on latest typescript-action

* Update workflow.yml to use same node version as action.yml

* Pull in improvements from open PRs. Fix package.json scripts

* Type function return arguments

* Don't eslint automatic formatting changes

* Initial implementation of ghc+cabal install for linux/mac/windows

* Update README

* Fix cabal version in action.yml

* Implement initial simplistic test suite

* Test action with CI

* Use chocolatey directly to install ghc and cabal

* Try pre-installed tool on linux first

* Clean up documentation

* Expand README

* Test super old GHC on ubuntu

* Implement support for stack

* Update documentation about Stack support

* Test stack install in Github Actions CI

authored-by: Jared Weakly <jweakly@galois.com>
2020-03-23 11:24:06 -07:00

1.0 KiB

Contributors

Checkin

  • Do checkin source (src)
  • Do checkin build output (dist)

Dependencies

In order to make sure that the ts files are always transpiled correctly, we run Husky before each commit. This step ensures that formatting rules are followed and that the typescript code has been transpiled correctly. To make sure Husky runs correctly, please use the following workflow:

npm install                                 # installs all dependencies including Husky
git add abc.ext                             # Add the files you've changed. This should include files in src and dist (see above)
git commit -m "Informative commit message"  # Commit. This will run Husky

During the commit step, Husky will take care of formatting all files with Prettier. It will also bundle the code into a single dist/index.js file. Finally, it will make sure these changes are appropriately included in your commit--no further work is needed.