diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..4435abb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +**Description of the change** + +Clearly and concisely describe the purpose of the pull request. If this PR relates to an existing issue or change proposal, please link to it. Include any other background context that would help reviewers understand the motivation for this PR. + +--- + +**Checklist:** + +- [ ] Added the change to the changelog's "Unreleased" section with a reference to this PR (e.g. "- Made a change (#0000)") +- [ ] Linked any existing issues or proposals that this pull request should close +- [ ] Updated or added relevant documentation +- [ ] Added a test for the contribution (if applicable) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2e4c7a1..66354b4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,7 +14,7 @@ jobs: - uses: purescript-contrib/setup-purescript@main with: - purescript: "0.14.0-rc3" + purescript: "0.14.0-rc5" - uses: actions/setup-node@v1 with: diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..631bafc --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,111 @@ +# Changelog + +Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +Breaking changes: + +New features: + +Bugfixes: + +Other improvements: + +## [v6.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v6.0.0) - 2019-03-15 + +Updated `purescript-foreign-object` dependency + +## [v5.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v5.0.0) - 2018-06-02 + +Updates for 0.12 + +**Breaking** + +- mkOnClose now reacts to the `close` signal instead of `exit` @Profpatsch +- `kill` returns Unit instead of Boolean @Profpatsch +- `exec`/`execFile` returns a ChildProcess @Profpatsch + +**Additions** + +- Bindings to the synchronous versions of exec @jyh1 + +## [v4.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v4.0.0) - 2017-04-05 + +Updates for 0.11 compiler + +## [v3.0.1](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v3.0.1) - 2016-11-19 + +- Fixed shadowed name warning + +## [v3.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v3.0.0) - 2016-10-22 + +- Updated dependencies + +## [v2.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v2.0.0) - 2016-07-31 + +- Updated dependencies + +## [v1.0.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v1.0.0) - 2016-06-19 + +Updates for 0.9.1 compiler and 1.0 core libraries. + +## [v0.6.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.6.0) - 2016-03-31 + +Bump dependencies (`purescript-node-streams` -> v0.4.0). + +## [v0.5.1](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.5.1) - 2016-01-14 + +- Add `execFile` + +## [v0.5.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.5.0) - 2016-01-06 + +- Bump dependencies (`node-fs` -> `~0.10.0`) + +## [v0.4.2](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.4.2) - 2016-01-01 + +- Fix `Node_ChildProcess.fork is not a function` errors when calling `Node.ChildProcess.fork` +- Fix unused import warnings + +## [v0.4.1](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.4.1) - 2015-12-31 + +- Fix `onError` never firing. Oops. + +## [v0.4.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.4.0) - 2015-12-29 + +- **Breaking change**: + - `SpawnOptions` now uses the `Uid` and `Gid` types from `purescript-posix-types` for its `uid` and `gid` options, instead of `Int`. +- **Additions**: + - Added `exec`. + +## [v0.3.2](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.3.2) - 2015-12-27 + +- Documentation updates + +## [v0.3.1](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.3.1) - 2015-12-27 + +- Move documentation to Pursuit +- Documentation updates + +## [v0.3.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.3.0) - 2015-12-27 + +- Use purescript-posix-types +- Fix a bug where `kill`, `connected`, and `send` would perform the effects too early +- Modify type names to avoid repeating the module name: `ChildProcessExit` -> `Exit`, and `ChildProcessError` -> `Error`. + +## [v0.2.0](https://github.com/purescript-node/purescript-node-child-process/releases/tag/v0.2.0) - 2015-12-27 + +- Use a `StrMap String` for child process environments in `spawn`, in order to ensure environment variable values are strings +- Allow inheritance of parent process environment by passing `Nothing` to the `env` parameter +- Use an opaque data type for `ChildProcess` values +- Use `Int` instead of `Number` where applicable (eg, `gid`, `uid`, `pid`) +- Require `Eff` for reading mutable state of a `ChildProcess` +- Simplify effects; now, we just have `cp :: CHILD_PROCESS` for spawning and communicating with child processes +- Use a sum type to allow more flexibility with what to do with standard IO streams / file descriptors in the child process after spawning +- Fix a bug where callbacks in `onExit` and `onClose` did not get called +- Add a `ChildProcessExit` type with information about how a child process exited +- Fix warnings +- Update dependencies: `purescript-node-streams` -> `~0.3.0` + +See https://github.com/joneshf/purescript-node-child-process/issues/2 for the rationale behind many of these changes. +