Releases: probot/probot
v8.0.0-beta.4
8.0.0-beta.4 (2019-01-30)
Bug Fixes
- remove deprecated "simulate" command (739e3a1)
- remove deprecated
catchErrors
constructor option (4a740ce) - remove handling deprecated
.event
property (a3fb089)
BREAKING CHANGES
- Deprecated
event.event
property is no longer handled. Useevent.name
instead - Deprecated
new Probot({catchErrors})
has been removed probot simulate
hase been removed, useprobot receive
instead
v8.0.0-beta.3
8.0.0-beta.3 (2019-01-27)
Bug Fixes
- create only a single redis connection when REDIS_URL is set (e1d7873)
v8.0.0-beta.2
v8.0.0-beta.1
BREAKING CHANGES
context.github.query()
: Changes in errors thrown due to GraphQL errorserror.name
is nowGraphqlError
, wasGraphQLQueryError
error.query
is nowerror.request.query
-
all previously deprecated methods have been removed
-
preview headers that are not required to use an API are no longer set automatically. Set using
{headers: { accept: '<preview header here>'}
-
.gitdata.getTags()
has been removed. Use.gitdata.listRefs({namespace: tags})
instead -
Methods for undocumented endpoints have been removed.
- Instead of
octokit.users.getById({id})
useoctokit.request('GET /user/:id', {id})
- Instead of
octokit.repos.getById({id})
useoctokit.request('GET /repositories/:id', {id})
- Instead of
-
octokit.enterprise.*
methods have been removed. Use your own@ocotkit/rest
instance and install the@octokit/enterprise-rest
plugin -
octokit.issues.addLabels
sendslabels
parameter with "labels
" namespace instead of sending the array in the request body root. This is not supported by GitHub Enterprise 2.15 or older. You have several options.- Use the
@octokit/enterprise-compatibility
plugin - Use the
@octokit/enterprise-rest
plugin loading all routes for the GHE version you want to support - Use
octokit.request()
directly:
octokit.request('/repos/:owner/:repo/issues/:number/labels', { owner, repo, number, data: ['label1', 'label2'] })
- Use the
-
The
milestone
parameter is no longer validated using a regex as it cannot be derived from octokit/routes -
error.status
is now the response status code number. The status text is no longer returned
Deprecations
-
context.github.query()
is nowcontext.github.graphql()
-
context.github.query(query, variables, headers)
is nowcontext.github.graphql(query, options)
.options.headers
is passed as headers. Other options are passed as variables, with the exception ofmethod
,baseUrl
,url
,headers
,request
, andquery
. -
context.github.paginate(promise, mapFn)
is nowcontext.github.paginate(requestOptions, mapFn)
. Example:Before
const allIssues = await context.github.paginate( context.github.issues.getAll(context.repo()) )
After
const allIssues = await context.github.paginate( context.github.issues.getAll.endpoint.merge(context.repo()) )
Features
- Pagination: the
.paginate
API from @octokit/rest.js is now used- .paginate(options, mapFn) now accepts the request options, just like
ocotkit.request
. - .paginate.iterator(options) allows for async iteration.
- .paginate(options, mapFn) now accepts the request options, just like
- Custom requests using octokit.request & octokit.request.endpoint.
- Improved Typescript definitions for
context.github
- new github.paginate API, github.paginate.iterator() (153a3fa)
- new throttling & automated retries (6f06f82)
Bug Fixes
- logging: error.status is the new error.code. The old error.status is no more (3b3d656)
- make
.issues.addLabels()
compatible with current GHE versions (d41c422)
Build System
v7.5.0
馃悾 Features
- Prefill Glitch app name as GitHub app name for app manifests (#742) @yeskunall
馃悳 Bug Fixes
- Fix typings for stats app (#728) @wolfy1339
- Update dotenv to the latest version 馃殌 (#781) @Greenkeeper[bot]
- Update @types/jsonwebtoken to the latest version 馃殌 (#757) @Greenkeeper[bot]
- PRIVATE_KEY_PATH error handling (#778) (#782) @NikhilM98
- Use path.resolve instead of path.join to resolve payload paths. (#785) @krtx
- Removed allowed failure configuration for node 10 (#802) @brwne
- Typescript: Fixed GitHubAPI.paginate callback signature (#775) @Eddman
- Typescript: Fix webhook payload definition (#793) @gimenete
- Typescript: Fix Webhooks class constructor (#798) @wolfy1339
馃幇 Others
- Fix misspellings of receive (#783) @FalconWiz
- Update simulating-webhooks.md (#796) @mayank23
- Fix link to "Create the GitHub App" (#786) @chadfawcett
- Fix link to "probot-metadata" extension (#787) @chadfawcett
- Added package-lock.json #769 (#791) @HaydenMeloche
- Spelling (#800) @jsoref
- Fix sample code for serverless deployment (#807) @kentaro-m
- Fix URL for Serverless GCF repository (#805) @pgoodjohn
- fix: Update year to 2019 (#812) @MarvinJWendt
- Add pull reminders badge to README (#814) @abinoda
Improvements
Improvements
- Docs: #739 @bkeepers, #740 @JasonEtco, #741 @yeskunall, #698 @bdougie, #734 @hiimbex, #756 @hiimbex, #752 @TimonVS, #773 @matchai
- Tests/Typescript improvements: #696 @macklinu, #704 @macklinu, #718 @TimonVS, #710 @bobvanderlinden
- Version updates: #750, #768 @gr2m - updating Octokit to v15.18
- Recent updates/Fixes:
v7.3.1
v7.3.0
Improvements
- Support for color in terminal logs will now automatically be detected, so no more ugly ASII escape codes in your logs (#708) @gimenete
- Deprecate
probot simulate
in favor ofprobot receive
(#726, #730) @gimenete, @hiimbex - Update
@octokit/rest
(#721, #732) @hiimbex - Wrap pem in quotes to make Glitch happy (#737) @wilhelmklopp
v7.2.0
Improvements
-
It's now easier to get started building your first Probot App thanks to support for GitHub App Manifests. Check out https://probot.github.io/docs/development/#configuring-a-github-app to learn more! (#650, #700, #701) by @wilhelmklopp, @bkeepers, and @hiimbex
-
Tests updates
- chore(tests): convert serializers test to TypeScript (#695) @macklinu
- Resolve Jest transform option deprecation warning (#694) @macklinu
See full changelog
7.1.2
Improvements
- Remove duplicated word (#682) @borNfreee
Security Update
- Require @octokit/webhooks@^5.0.2 (#691) @gr2m
- See Release notes for more info: https://github.com/octokit/webhooks.js/releases/tag/v5.0.2