diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +# 0.11.0 + +* OwnerType of Bot is now supported (by Domen Kozar, resolves #22) +* GHC-7.10 requires less changes to build the bundled examples (resolves #6) +* Fixed issues to do with updated stack package format and CI build (resolves #23, et al.) +* Added a security policy clarifying how security issues should be disclosed (resolves #24) +* The latest release is now available on the `release` branch (resolves #10) + +# 0.10.1 + +* Fixed a bug parsing related PR with empty body (by Rob Berry) +* Updated copyright and contact information + # 0.10.0 * Significantly improved documentation coverage and added module descriptions (by Christian Sakai, resolves #5) diff --git a/github-webhooks.cabal b/github-webhooks.cabal --- a/github-webhooks.cabal +++ b/github-webhooks.cabal @@ -1,11 +1,13 @@ --- This file has been generated from package.yaml by hpack version 0.21.2. +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.31.2. -- -- see: https://github.com/sol/hpack -- --- hash: e310b493da67a9769074061f068306cf777edfa12e5ef3fc1ca0da4fdcf15fbd +-- hash: a6f178730e675270b0f0ac76e237c8ff5d6da7610a4a7a9b552cb2d78e5d1a03 name: github-webhooks -version: 0.10.1 +version: 0.11.0 synopsis: Aeson instances for GitHub Webhook payloads. description: Complete instances for decoding GitHub Webhook payloads (using @aeson@). See the README at for examples. category: GitHub @@ -14,15 +16,19 @@ author: Kyle Van Berendonck , Christian Sakai , Thomas DuBuisson , - Rob Berry + Rob Berry, + Domen Kozar maintainer: Kyle Van Berendonck copyright: (c) 2017-2019 ONROCK license: MIT license-file: LICENSE build-type: Simple -cabal-version: >= 1.10 - extra-source-files: + package.yaml + stack.yaml + stack-ghc-7.10.yaml + stack-ghc-7.8.yaml + stack-ghc-8.0.yaml CHANGELOG.md fixtures/commit-comment-event.json fixtures/create-event.json @@ -57,21 +63,20 @@ fixtures/team-add-event.json fixtures/team-event.json fixtures/watch-event.json - package.yaml - stack-ghc-7.10.yaml - stack-ghc-7.8.yaml - stack-ghc-8.0.yaml - stack.yaml source-repository head type: git location: https://github.com/onrock-eng/github-webhooks +flag ci + description: A stricter build designed for continuous integration. + manual: True + default: False + library hs-source-dirs: src default-extensions: DeriveDataTypeable DeriveGeneric OverloadedStrings - ghc-options: -Wall -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates build-depends: aeson , base ==4.* @@ -84,6 +89,8 @@ , text , time , vector + if flag(ci) + ghc-options: -Wall -Werror -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates -ddump-to-file -ddump-hi exposed-modules: GitHub.Data.Webhooks.Events GitHub.Data.Webhooks.Payload @@ -98,7 +105,6 @@ hs-source-dirs: spec default-extensions: DeriveDataTypeable DeriveGeneric OverloadedStrings ScopedTypeVariables - ghc-options: -Wall -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates build-depends: aeson , base ==4.* @@ -107,6 +113,8 @@ , hspec ==2.* , text , vector + if flag(ci) + ghc-options: -Wall -Werror -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates -ddump-to-file -ddump-hi other-modules: DecodeEventsSpec Paths_github_webhooks diff --git a/package.yaml b/package.yaml --- a/package.yaml +++ b/package.yaml @@ -1,5 +1,5 @@ name: github-webhooks -version: 0.10.1 +version: 0.11.0 category: GitHub license: MIT @@ -16,14 +16,22 @@ - Christian Sakai - Thomas DuBuisson - Rob Berry + - Domen Kozar maintainer: Kyle Van Berendonck github: onrock-eng/github-webhooks description: Complete instances for decoding GitHub Webhook payloads (using @aeson@). See the README at for examples. +flags: + ci: + description: A stricter build designed for continuous integration. + default: false + manual: true -ghc-options: - - -Wall -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates + +when: + - condition: flag(ci) + ghc-options: -Wall -Werror -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates -ddump-to-file -ddump-hi default-extensions: - DeriveDataTypeable diff --git a/src/GitHub/Data/Webhooks/Payload.hs b/src/GitHub/Data/Webhooks/Payload.hs --- a/src/GitHub/Data/Webhooks/Payload.hs +++ b/src/GitHub/Data/Webhooks/Payload.hs @@ -59,8 +59,11 @@ -- Types lifted from the @github@ package. --- | Represents the owner of the repository. -data OwnerType = OwnerUser | OwnerOrganization +-- | Represents the owner of a repository, pull request or similar. +-- +-- A bot is a "special type of user which takes actions on behalf of GitHub Apps". +-- See also https://developer.github.com/v4/object/bot/ +data OwnerType = OwnerUser | OwnerOrganization | OwnerBot deriving (Eq, Ord, Enum, Bounded, Show, Read, Generic, Typeable, Data) instance NFData OwnerType @@ -70,6 +73,7 @@ case T.toLower t of "user" -> pure OwnerUser "organization" -> pure OwnerOrganization + "bot" -> pure OwnerBot _ -> fail $ "Unknown owner type: " ++ T.unpack t diff --git a/stack-ghc-7.10.yaml b/stack-ghc-7.10.yaml --- a/stack-ghc-7.10.yaml +++ b/stack-ghc-7.10.yaml @@ -1,12 +1,8 @@ resolver: lts-6.35 extra-deps: # Needed for servant examples -- servant-github-webhook-0.3.2.1 -packages: -- . -- location: ./examples/servant-simple - extra-dep: true -- location: ./examples/servant - extra-dep: true -- location: ./examples/scotty - extra-dep: true +- servant-github-webhook-0.4.1.0 +# Examples +- ./examples/servant-simple +- ./examples/servant +- ./examples/scotty diff --git a/stack-ghc-7.8.yaml b/stack-ghc-7.8.yaml --- a/stack-ghc-7.8.yaml +++ b/stack-ghc-7.8.yaml @@ -1,12 +1,8 @@ resolver: lts-2.22 extra-deps: # Needed for servant examples -- servant-github-webhook-0.4.0.0 -packages: -- . -- location: ./examples/servant-simple - extra-dep: true -- location: ./examples/servant - extra-dep: true -- location: ./examples/scotty - extra-dep: true +- servant-github-webhook-0.4.1.0 +# Examples +- ./examples/servant-simple +- ./examples/servant +- ./examples/scotty diff --git a/stack-ghc-8.0.yaml b/stack-ghc-8.0.yaml --- a/stack-ghc-8.0.yaml +++ b/stack-ghc-8.0.yaml @@ -1,12 +1,8 @@ resolver: lts-7.24 extra-deps: # Needed for servant examples -- servant-github-webhook-0.3.2.1 -packages: -- . -- location: ./examples/servant-simple - extra-dep: true -- location: ./examples/servant - extra-dep: true -- location: ./examples/scotty - extra-dep: true +- servant-github-webhook-0.4.1.0 +# Examples +- ./examples/servant-simple +- ./examples/servant +- ./examples/scotty diff --git a/stack.yaml b/stack.yaml --- a/stack.yaml +++ b/stack.yaml @@ -1,12 +1,8 @@ resolver: lts-11.5 extra-deps: # Needed for servant examples -- servant-github-webhook-0.3.2.1 -packages: -- . -- location: ./examples/servant-simple - extra-dep: true -- location: ./examples/servant - extra-dep: true -- location: ./examples/scotty - extra-dep: true +- servant-github-webhook-0.4.1.0 +# Examples +- ./examples/servant-simple +- ./examples/servant +- ./examples/scotty