Skip to content

Commit 27ebc23

Browse files
Generate changelog and add PR template (#82)
* Add pull request template * Update CI in PS to v0.14.0-rc5 * Generate CHANGELOG.md file using notes from previous GH releases
1 parent 161641e commit 27ebc23

File tree

3 files changed

+179
-1
lines changed

3 files changed

+179
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**Description of the change**
2+
3+
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.
4+
5+
---
6+
7+
**Checklist:**
8+
9+
- [ ] Added the change to the changelog's "Unreleased" section with a reference to this PR (e.g. "- Made a change (#0000)")
10+
- [ ] Linked any existing issues or proposals that this pull request should close
11+
- [ ] Updated or added relevant documentation
12+
- [ ] Added a test for the contribution (if applicable)

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414

1515
- uses: purescript-contrib/setup-purescript@main
1616
with:
17-
purescript: "0.14.0-rc3"
17+
purescript: "0.14.0-rc5"
1818

1919
- uses: actions/setup-node@v1
2020
with:

CHANGELOG.md

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# Changelog
2+
3+
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).
4+
5+
## [Unreleased]
6+
7+
Breaking changes:
8+
9+
New features:
10+
11+
Bugfixes:
12+
13+
Other improvements:
14+
15+
## [v5.0.0](https://github.com/purescript/purescript-foreign/releases/tag/v5.0.0) - 2018-05-24
16+
17+
- Updated for PureScript 0.12
18+
- `renderForeignError` now renders nested errors correcty (@abhin4v)
19+
- The namespace is now `Foreign` rather than `Data.Foreign`
20+
- The `JSONError` constructor was removed. This library is not for JSON, it was a bad name - use `ForeignError` instead.
21+
- `toForeign` has been renamed as `unsafeToForeign` with a comment explaining its intended usage and potential risks
22+
23+
## [v4.0.1](https://github.com/purescript/purescript-foreign/releases/tag/v4.0.1) - 2017-06-08
24+
25+
Fix `Show` instance for `ForeignError` (@rightfold)
26+
27+
## [v4.0.0](https://github.com/purescript/purescript-foreign/releases/tag/v4.0.0) - 2017-03-29
28+
29+
- Updated for PureScript 0.11
30+
- The library has been drastically simplified to focus on its core use; validating and extracting data from foreign values. This involves changes such as:
31+
- Removal of `IsForeign` / `AsForeign` classes
32+
- Removal of `parseJSON` as this library is not intended for general JSON parsing
33+
- New functions were added for `readNull`, `readUndefined`, `readNullOrUndefined` rather than using the newtypes to direct `IsForeign` choice as it was before
34+
- The `(!)` index/property reading operator has been enhanced to work with `Foreign` or `F Foreign` on the left hand side, allowing for chained property reads
35+
36+
## [v3.2.0](https://github.com/purescript/purescript-foreign/releases/tag/v3.2.0) - 2017-01-29
37+
38+
Add instances for `Null`, `Undefined` and `NullOrUndefined` (@felixSchl)
39+
40+
## [v3.0.1](https://github.com/purescript/purescript-foreign/releases/tag/v3.0.1) - 2016-11-14
41+
42+
- Fixed shadowed name warning
43+
44+
## [v3.0.0](https://github.com/purescript/purescript-foreign/releases/tag/v3.0.0) - 2016-10-16
45+
46+
- Updated lists dependency
47+
48+
## [v2.0.0](https://github.com/purescript/purescript-foreign/releases/tag/v2.0.0) - 2016-10-13
49+
50+
- Updated dependecies
51+
- `F` now uses `Except` and allows for the accumulation of multiple errors when using `<|>` in parsing
52+
53+
## [v1.1.0](https://github.com/purescript/purescript-foreign/releases/tag/v1.1.0) - 2016-08-09
54+
55+
- Added `AsForeign` class and combinators for writing values as `Foreign` (@puffnfresh)
56+
57+
## [v1.0.0](https://github.com/purescript/purescript-foreign/releases/tag/v1.0.0) - 2016-06-01
58+
59+
This release is intended for the PureScript 0.9.1 compiler and newer.
60+
61+
**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.
62+
63+
## [v1.0.0-rc.1](https://github.com/purescript/purescript-foreign/releases/tag/v1.0.0-rc.1) - 2016-03-25
64+
65+
- Release candidate for the psc 0.8+ core libraries
66+
67+
## [v0.7.2](https://github.com/purescript/purescript-foreign/releases/tag/v0.7.2) - 2015-11-20
68+
69+
- Fixed shadowed type variable warnings (@tfausak)
70+
71+
## [v0.7.1](https://github.com/purescript/purescript-foreign/releases/tag/v0.7.1) - 2015-11-09
72+
73+
Fix a type error.
74+
75+
## [v0.7.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.7.0) - 2015-08-13
76+
77+
- Updated dependencies
78+
79+
## [v0.6.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.6.0) - 2015-08-02
80+
81+
- Updated dependencies
82+
83+
## [v0.5.1](https://github.com/purescript/purescript-foreign/releases/tag/v0.5.1) - 2015-07-19
84+
85+
- Added `IsForeign` instances for `Int` and `Char` (@anttih)
86+
87+
## [v0.5.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.5.0) - 2015-06-30
88+
89+
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.
90+
91+
## [v0.5.0-rc.2](https://github.com/purescript/purescript-foreign/releases/tag/v0.5.0-rc.2) - 2015-06-15
92+
93+
Rename `!` operator to `ix`.
94+
95+
## [v0.5.0-rc.1](https://github.com/purescript/purescript-foreign/releases/tag/v0.5.0-rc.1) - 2015-06-10
96+
97+
Initial release candidate of the library intended for the 0.7 compiler.
98+
99+
## [v0.4.2](https://github.com/purescript/purescript-foreign/releases/tag/v0.4.2) - 2015-03-26
100+
101+
- `unsafeReadTagged` is now exposed (@garyb)
102+
103+
## [v0.4.1](https://github.com/purescript/purescript-foreign/releases/tag/v0.4.1) - 2015-03-20
104+
105+
Updated docs
106+
107+
## [v0.4.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.4.0) - 2015-02-21
108+
109+
**This release requires PureScript v0.6.8 or later**
110+
- Updated dependencies
111+
112+
## [v0.3.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.3.0) - 2015-01-10
113+
114+
- Made dependency versions explicit (@garyb)
115+
116+
## [v0.2.3](https://github.com/purescript/purescript-foreign/releases/tag/v0.2.3) - 2014-12-11
117+
118+
- Added ES3 fallbacks for `Array.isArray` and `Object.keys` (@davidchambers)
119+
120+
## [v0.2.2](https://github.com/purescript/purescript-foreign/releases/tag/v0.2.2) - 2014-11-19
121+
122+
123+
124+
## [v0.2.1](https://github.com/purescript/purescript-foreign/releases/tag/v0.2.1) - 2014-11-18
125+
126+
- `IsForeign` instance for `Foreign`. (@MichaelXavier)
127+
128+
## [v0.2.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.2.0) - 2014-08-20
129+
130+
Quite a few breaking changes to both names and types:
131+
- A type for errors instead of using string concatenation.
132+
- Breaking a few functions out into their own submodules.
133+
- Adding types and instances to handle null-like values.
134+
- Use the `Either` monad instead of the `ForeignParser` monad.
135+
136+
## [v0.1.6](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.6) - 2014-08-09
137+
138+
- Removed unused dependency on `purescript-globals` (@garyb)
139+
140+
## [v0.1.5](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.5) - 2014-08-08
141+
142+
- Removed `ReadForeign Error` instance after `Error` was removed from `Global` (@AitorATuin)
143+
144+
## [v0.1.4](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.4) - 2014-07-29
145+
146+
- Added `index` (@philopon)
147+
- Rewrote some calls to `runFnX` to trigger inlining optimisation (@garyb)
148+
149+
## [v0.1.3](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.3) - 2014-07-26
150+
151+
- Updated FFI code to work for changes in codegen (@garyb)
152+
- Added `keys` to read a list of key names from an object (@andreypopp)
153+
- Fixed bug in `prop` that may have resulted in runtime errors when the object is null (@andreypopp)
154+
155+
## [v0.1.2](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.2) - 2014-06-02
156+
157+
- Added `ReadForeign Error` instance (garyb)
158+
159+
## [v0.1.1](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.1) - 2014-04-27
160+
161+
162+
163+
## [v0.1.0](https://github.com/purescript/purescript-foreign/releases/tag/v0.1.0) - 2014-04-26
164+
165+
166+

0 commit comments

Comments
 (0)