Changelog for 7.0.0 #1790
Merged
Changelog for 7.0.0 #1790
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These are pending changes for Sopel 7, i.e. PRs that were merged to master and should be mentioned in the changelog. The whole branch should be squashed down into the version bump when release time comes, rather than preserving all the commits from this one (they'll be mostly one- or two-liners, so not worth keeping). Maintaining this branch is merely a convenience, intended to eliminate the arduous process of going through the commit log for Sopel 7.0.0, which will probably contain hundreds of commits once all is said and done, to write the changelog entry all at once. Doing that is error-prone, while adding changes as they're merged will make sure everything that needs to be mentioned, is. (Well, it will once I fill in the PRs that have already been merged for 7.0.0.)
No #-reference because this commit/branch is intended to be squashed.
It's a good thing I'm planning to squash this branch down.
Might decide to link a different way (with support from the website changelog-generator script), because honestly this method is really tedious. I'm not a fan of the huge list of links, either. Auto-linking to GitHub issue/PR numbers should be easy enough. The only instances of `#\d+` in the file are GitHub references, in fact. Probably quite simple to just insert a conversion step into document_versions.py that converts anything that looks like an issue reference into a link. The biggest challenge would be figuring out whether to use `/issues/` or `/pull/` in the URL, but that's not critical—GitHub understands both no matter what and redirects to the correct type.
Starts out basic, but the main point is to add a link to the (still-in-progress) Sopel 7 migration guide. We're on track to include over a hundred merged pull requests and closed issues in Sopel 7, and the list of changes will include some trivial stuff that doesn't really affect users or developers much. That's why the important stuff also gets an entry in the migration guide.
Having the link references indented after the change list makes them easier to pick out when editing the file, but Kramdown (at least) wraps the final list item in an unnecessary <p> element when converting the Markdown to HTML if the content after the last item is indented.
Also updated the migration guide link, to match website restructuring.
Can't believe a single PR managed to qualify for inclusion in all three changelog entry sections…
Nearly forgot to add this one to the changelog. Definitely need a better (read: more rigorous) process for doing this.
* `ListAttribute` support for commas inside values * Official deprecation of `contains()` methods on `SopelMemory` classes * Start of API documentation overhaul (tracked in issue 1565)
Covers PRs 1711, 1712, 1720, & 1734
Covers PRs 1721, 1723, 1724, 1725, & 1728 (a couple of which were merged some time ago but somehow left out of the changelog until now).
Covers PRs 1673, 1731, & 1732. Also fixes the entry for `away` tracking, since the line was slightly too long per our style guide.
Technically 1760 isn't merged yet, but it definitely will be (perhaps with a minor tweak or two). Easiest to just add it along with the other, since these should be the last PRs to touch reddit for 7.0.
Covers PRs 1742, 1743, & 1747.
Covers PRs 1762, 1773, & 1779
Covers PRs 1751, 1758, & 1769
Identifier lowercase fix/migration (PR 1744) & API compatibility fix for `bot.db.execute()` method (PR 1783).
All have been approved and are ready to merge, except for possible merge conflicts. We will not release 7.0 until all of these are merged. PRs: 1766, 1770, 1771, 1772, 1775, 1776, 1778, 1782 This commit also tweaks/expands the changelog entry for our overhaul of the API documentation to describe more of what we did.
Covers PR 1788 and updates the entries for 1782 & 1499
Exirel
approved these changes
Dec 29, 2019
No more PRs will be added to the 7.0.0 milestone except under catastrophic conditions, i.e. broken build or changed external API.
Glad someone caught this for us *before* release!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a large changeset (almost 700 lines), but I'd really appreciate it if multiple @sopel-irc/rockstars could look it over. Y'all are pretty likely to notice if a fix/change is missing or incorrectly described, on top of the usual proofreading for grammar/spelling. There are only a very few PRs left for 7.0.0, so it's time to get this ready.
PS: I changed my mind in the months since 0d571f8, and will probably keep all of these commits (maybe with the silly "PR 1234" references in the commit log changed to
#1234instead—I did that to avoid spamming mentions in PR timelines during rebases).