Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core Library - Adding changelogs and PR templates #3984

Closed
JordanMartinez opened this issue Jan 9, 2021 · 10 comments
Closed

Core Library - Adding changelogs and PR templates #3984

JordanMartinez opened this issue Jan 9, 2021 · 10 comments

Comments

@JordanMartinez
Copy link
Contributor

This issue tracks PRs, so that we can more easily know which ones have yet to be merged. It'll follow the same format used in purescript/purescript-prelude#252

@rhendric
Copy link
Member

rhendric commented Jan 9, 2021

For the ‘unreleased’ sections, is it worth adding another step to submitting PRs and another place for merge conflicts to arise (if there is any concurrent development, this pretty much guarantees merge conflicts), versus using one of the many tools for automatically generating the new changelog fragment from Git commit messages?

@thomashoneyman
Copy link
Member

@f-f have you experienced challenges with this in Spago?

@f-f
Copy link
Member

f-f commented Jan 9, 2021

In my experience conflicts arising from the Changelog are very rare, and in any case very easy to solve (even from GitHub's own interface).
I think the Changelog should not be generated from GitHub commits but should be typed by a human, tailored to the audience that's supposed to read it - e.g. in Spago we use the changelog content for populating the Release notes and for the Discourse posts, so it's more for users rather than contributors.

@JordanMartinez
Copy link
Contributor Author

I'm going to run the script. Each lib will get hit with the updates. Sorry for spamming your notifcations.

@JordanMartinez
Copy link
Contributor Author

Sigh... something else came up. I'll work on this tomorrow.

This was referenced Jan 10, 2021
This was referenced Jan 10, 2021
@JordanMartinez
Copy link
Contributor Author

PRs for the following packages did not generate the CHANGELOG.md file due to the following error.:

throw util.fromLeft(step);
                  ^

Error: An error occurred while decoding a JSON value:
  Expected value of type 'Array'.

List of repos (in order of appearance):
exists
gen
foreign
catenable-lists
lcg
minibench
integers
numbers
unfoldable
const
contravariant
st
refs
random
tailrec
distributive
exceptions
invariant
safe-coerce
functions
assert
console
unsafe-coerce
parallel

@JordanMartinez
Copy link
Contributor Author

Yup, got rate limited. That's easy to fix, but I'll do it later.

@JordanMartinez
Copy link
Contributor Author

Ok, all PRs should have their changelog included in the PR now.

@JordanMartinez
Copy link
Contributor Author

All PRs have been merged. Moreover, all repos were updated to v0.14.0-rc5. Closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants