From 2358b1007deb5045c27c1cdd20a4a28d756c65cf Mon Sep 17 00:00:00 2001 From: JordanMartinez Date: Sun, 10 Jan 2021 14:47:35 -0800 Subject: [PATCH] Generate changelog and add PR template (#32) * Add pull request template * Update CI in PS to v0.14.0-rc5 * Generate CHANGELOG.md file using notes from previous GH releases --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++ .github/workflows/ci.yml | 2 +- CHANGELOG.md | 98 ++++++++++++++++++++++++++++++++ 3 files changed, 111 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CHANGELOG.md 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 55efa3d..f4f44e5 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..8dceb48 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,98 @@ +# 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: + +## [v4.1.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v4.1.0) - 2020-01-26 + +Added instances for `Maybe` + +## [v4.0.2](https://github.com/purescript/purescript-unfoldable/releases/tag/v4.0.2) - 2019-05-29 + +Documentation improvements: give every function at least one example, and fix a couple of minor errors. + +## [v4.0.1](https://github.com/purescript/purescript-unfoldable/releases/tag/v4.0.1) - 2019-05-28 + +* Improved documentation to clarify the relationship between `Unfoldable` and `Unfoldable1`. + +## [v4.0.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v4.0.0) - 2018-05-23 + +- Updated for PureScript 0.12 +- `Unfoldable1` is now a superclass of `Unfoldable` (if a value can be unfolded from something that is possibly empty, it can certainly be unfolded from something that is not empty). This also matches the relationship of `Foldable` and `Foldable1`, albeit in reverse. + +## [v3.2.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v3.2.0) - 2018-04-07 + +- Added `Unfoldable1` class (@matthewleon, @garyb) + +## [v3.1.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v3.1.0) - 2017-12-10 + +Add `range` for unfolding a range of integers (@matthewleon) + +## [v3.0.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v3.0.0) - 2017-03-26 + +- Updated for PureScript 0.11 + +## [v2.0.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v2.0.0) - 2016-10-07 + +- Updated dependencies + +## [v1.1.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v1.1.0) - 2016-09-30 + +Add `fromMaybe` (@eskimor) + +## [v1.0.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v1.0.0) - 2016-06-01 + +This release is intended for the PureScript 0.9.1 compiler and newer. + +**Note**: The v1.0.0 tag is not meant to indicate the library is “finished”, the core libraries are all being bumped to this for the 0.9 compiler release so as to use semver more correctly. + +## [v1.0.0-rc.2](https://github.com/purescript/purescript-unfoldable/releases/tag/v1.0.0-rc.2) - 2016-04-02 + +- Removed dependency on `purescript-arrays` so as to enable a `toUnfoldable` implementation in `Data.Array` + +## [v1.0.0-rc.1](https://github.com/purescript/purescript-unfoldable/releases/tag/v1.0.0-rc.1) - 2016-03-17 + +- Release candidate for the psc 0.8+ core libraries + +## [v0.4.1](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.4.1) - 2015-09-26 + +Adds `replicate`, `replicateA`, `none`, and `singleton` (@LiamGoodacre) + +## [v0.4.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.4.0) - 2015-06-30 + +This release works with versions 0.7.\* of the PureScript compiler. It will not work with older versions. If you are using an older version, you should require an older, compatible version of this library. + +## [v0.4.0-rc.1](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.4.0-rc.1) - 2015-06-07 + +Initial release candidate of the library intended for the 0.7 compiler. + +## [v0.3.2](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.3.2) - 2015-03-18 + +Update docs + +## [v0.3.1](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.3.1) - 2015-03-17 + +Update docs + +## [v0.3.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.3.0) - 2015-02-21 + +**This release requires PureScript v0.6.8 or later** +- Updated dependencies + +## [v0.2.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.2.0) - 2014-11-28 + + + +## [v0.1.0](https://github.com/purescript/purescript-unfoldable/releases/tag/v0.1.0) - 2014-08-27 + + +