NEWS

## Changelog

### 0.5.0

This is the first release named `sopel-github`. Previous versions of this plugin
were known as `sopel_modules.github`, and are still available from PyPI for
users running Sopel 7.x or older.

Added:
* Support for inline references to issues/PRs from _any_ repo (#125)
* Timestamps in issue, PR, and comment output (#126)
* Configurable skipping of short inline issue/PR numbers (#137)
  * This is to help bot owners deal with e.g. people talking about their `#1`
    _something_ and the bot posts your project's first issue.

Changed:
* Modernized for newer Sopel versions (#110, #138)
* Send version header to GitHub API (#122)
* Reworked PR merge status lookup (#123)

Fixed:
* Handle directory links, not just files (#134)
* Suppress errors for invalid inline issue references (#136)

Removed:
* Obsolete `secret` setting (#124)

Meta:
* New package name, `sopel-github` (#138)
* Sopel 8.0+ now required (#138)
* Made optional `:emoji_name:` conversion a setuptools extra (#120, #140)
  * Install `sopel-github[emojize]` to enable this feature.


### 0.4.8

Changed:
* Use `emoji` 2.0 API style (#119)
  * If you installed the `emoji` package and its version is <1.7.0, you will
    need to `pip install --upgrade emoji`.
  * A future version of sopel-github will make this optional dependency easier
    to manage with a setuptools extra.

Fixed:
* Wrong webhook payload attributes used in push handler (#117)


### 0.4.7

Added:
* Special `.gh-repo !clear` syntax to delete a channel's linked repo (#112)
* Output relative committer & author date for commit URLs (#114)

Changed:
* Prettified `.gh-repo` output (#112)

Fixed:
* `NameError` in `.gh version` subcommand ( #111)
* `TypeError` in `.gh-repo` in channel with no linked repository (#112)
* Incorrect plural "1 changes" in commit output (#113)
* Reduced false-positive Markdown heading detection (#115)
* Ignore URI fragments in repo links (#116)


### 0.4.6

Changed:
* No longer attempt to shorten links with shut-down git.io (#106)

Fixed:
* Fix some edge cases in excerpted comment bodies (#105)
* Clean up some output-formatting code (#107)


### 0.4.5

Fixed:
* Link matching did not allow for underscore (`_`) in repo names (#100)


### 0.4.4

Fixed:
* Regression in handling inline/standalone issue references (#99)


### 0.4.3

Changed:
* Skip trying to handle non-repo links, e.g. to topics (#97)

Fixed:
* Issue comment handling tries to access state (#95)
* Error in cases where issue/PR body is empty (#98)


### 0.4.2

Added:
* Include issue/PR state when fetching info (#87)

Changed:
* Link shortening failures will be logged for debugging (#88)


### 0.4.1

Added:
* Include link to issue/PR in output when triggered by bare numeric reference
  in chat (#85)

Fixed:
* Double space in output of "self-assigned" webhook events (#80)


### 0.4.0

Added:
* Optionally treat references like `#123` in chat as issue references,
  configurable per-channel with new `.gh-repo` command (#65)
* Webhook handling for issue transfer events (#75)
* Rudimentary handling for links to files (#76)
  * Will try to show a useful text snippet if link points to a line/range
* Webhook handling for PR converted from Ready to Draft (#77)

Changed:
* PR output includes more details (#69)
  * Author's name added if merged PR was not created by the merging user
  * Repo owner's name added to refs if PR head branch is in a fork
* Commit references in webhook output will be abbreviated in most cases (#78)
* Include title in assignee, label, & milestone webhook output (#79)

Fixed:
* Skip label-related events that do not include the label object (#66)
  * Avoids channel spam when deleting a label, for example
* Correct fallback behavior for `.gh` command with no argument (#68)
* Avoid "Socket already in use" error when IRC reconnects (#72)


### 0.3.2

Fixed:
* Unhandled exception on linked issue/PR with empty description (#67)


### 0.3.1

Fixed:
* Use of deprecated method `bot.msg()` (#63)
* Use of deprecated `bot.privileges` property (#64)


### 0.3.0

Changed:
* Require Sopel 7.x and use its features (#58, #61)
* Ignore lines that look like (HTML) comments or headings when shortening
  comment bodies (#57)
* Deprecated query string API authentication replaced by HTTP Basic Auth (#62)

Fixed:
* Handle missing user information in commit data (#59)


### 0.2.6

Fixed:
* Syntax error in webhook code


### 0.2.5

Added:
* Error handler in webhook authorization (#51)

Fixed:
* Wrong config value access in webhook authorization (#51)


### 0.2.4

Fixed:
* Comments with trailing whitespace incorrectly had `[…]` appended even if the
  body contained only one line of (non-quoted) text (#50)


### 0.2.3

Changed:
* Milestone name is now included in `demilestoned` webhook events (#46)
  * GitHub originally didn't include this information in the webhook payload,
    but started sending it in approximately late-summer 2019

Fixed:
* Comments that were not truncated would still have `[…]` appended if the
  comment body included quoted text (#47)


### 0.2.2

Changed:
* Comment bodies will be shortened to approx. 250 characters, to try and stay
  within the length limit of one IRC line (#45)

Fixed:
* Repo URLs can be detected even with leading text on the line (#44)


### 0.2.1

Fixed:
* Comments containing blank lines would cause errors (#43)


### 0.2.0

Added:
* Handling for several new event types:
  * Pull request reviews (#20)
  * Pull request assignments (#23)
  * Pull request labels (#23)
  * Pull request milestones (#35)
  * Issue & pull request title edits (#36)
  * Releases (#21)
* Handling of draft pull requests (#34)
* Handling for draft pull requests marked ready for review (#34)
* Converting `:emoji:` to Unicode emoji in most text output (#17)
  * Requires optional dependency: https://pypi.org/project/emoji/

Changed:
* `secret` setting is now called `client_secret` (#42)
  * The plugin will automatically migrate configs to use the new name, but
    manual editing is encouraged in advanced setups (e.g. if the user Sopel
    runs as cannot write to the config file)
* Quoted text is ignored when generating comment output (#41)
* Unicode ellipsis now used instead of three periods (#31)
* Oxford comma now used in generated lists (#40)
* Webhook payload processing is handed off to a separate thread (#22)
  * Bottle can handle only one request at a time; doing this should minimize
    the potential for failed deliveries, as GitHub's webhook delivery service
    times out very quickly

Fixed:
* GitHub URL regexes should match all possible usernames & repo names (#38)
  * Of particular note: dots (`.`) are now recognized in repository links,
    such as Sopel's website repo: https://github.com/sopel-irc/sopel.chat


### 0.1.7

Fixed:
* Error with empty issue/PR description or commit message (#39)


### 0.1.6

Changed:
* Webhook now says "merged" instead of "closed" for merged PRs (#18)
* Re-opened issues/PRs will also trigger the webhook now (#27)

Fixed:
* Webhook ignores issue, PR, and review comments that were edited (#16, #24)
* Commit summary correctly says "1 file" instead of "1 files" (#37)
* Some webhook output grammar fixed (#15)
* Handle comments submitted via email correctly WRT line-endings (#30)
* Replace uses of long-deprecated `SopelMemory` method (#33)


### 0.1.5

Fixed:
* Refactoring unintentionally broke registering new repo webhooks (#14)

Meta:
* PyPI package description should be rendered to HTML now (fixed content-type)


### 0.1.4

Changed:
* "GitHub" is now properly capitalized everywhere in text output (#9)
* Usage output uses `help_prefix` from config instead of hardcoded `.` (#12)

Fixed:
* git.io shortening was cutting off GET parameters of input links. (#11)


### 0.1.3

Meta:
* Moved to Sopel organization on GitHub; new maintainer

Changed:
* Uses requests instead of deprecated sopel.web functions (Sopel itself
  requires requests, so we don't have to.)
* Fetched git.io links use HTTPS now