guibou / krank

Krank checks your code source comments for important markers

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

What is a github developer key and where do I get it?

peti opened this issue · comments

Could you briefly document how to use --issuetracker-githubkey, please?

Hi peti.

Thank you for your comment. The --issuetracke-githubkey option is documented here: https://github.com/guibou/krank/blob/master/docs/Checkers/IssueTracker.md#api-rate-limitation

Could you detail what is missing from this documentation or if you have any idea to improve its discoverability?

Thank you.

To add a bit more information. Right now I have an github API key in a ~/krank_token in my home directory and I'm calling it like that:

$ krank  pkgs/development/haskell-modules/configuration-common.nix --issuetracker-githubkey $(cat ~/krank_token)

pkgs/development/haskell-modules/configuration-common.nix:52:5: error:
  now Closed: https://github.com/bos/statistics/issues/123

pkgs/development/haskell-modules/configuration-common.nix:67:5: info:
  still Open: https://gitlab.com/twittner/zeromq-haskell/issues/63

pkgs/development/haskell-modules/configuration-common.nix:90:12: info:
  still Open: https://github.com/psibi/shell-conduit/issues/12

pkgs/development/haskell-modules/configuration-common.nix:94:5: info:
  still Open: https://github.com/froozen/kademlia/issues/2

pkgs/development/haskell-modules/configuration-common.nix:132:58: info:
  still Open: https://github.com/markus-git/feldspar-signal/issues/1

pkgs/development/haskell-modules/configuration-common.nix:135:68: error:
  now Closed: https://github.com/haskell/haddock/issues/979

pkgs/development/haskell-modules/configuration-common.nix:137:5: info:
  still Open: https://github.com/techtangents/ablist/issues/1

pkgs/development/haskell-modules/configuration-common.nix:140:22: error:
  now Closed: https://github.com/haskell/vector/issues/47

pkgs/development/haskell-modules/configuration-common.nix:141:22: error:
  now Closed: https://github.com/haskell/vector/issues/138

pkgs/development/haskell-modules/configuration-common.nix:177:5: error:
  now Closed: https://github.com/jputcu/serialport/issues/25

pkgs/development/haskell-modules/configuration-common.nix:183:5: info:
  still Open: https://github.com/kazu-yamamoto/simple-sendfile/issues/17

pkgs/development/haskell-modules/configuration-common.nix:192:59: error:
  now Closed: https://github.com/decomputed/euler/issues/1

pkgs/development/haskell-modules/configuration-common.nix:199:59: info:
  still Open: https://github.com/anchor/marquise/issues/69

pkgs/development/haskell-modules/configuration-common.nix:229:5: error:
  now Closed: https://github.com/haskell-nix/hnix/issues/514

pkgs/development/haskell-modules/configuration-common.nix:242:5: info:
  still Open: https://github.com/ekmett/structures/issues/3

pkgs/development/haskell-modules/configuration-common.nix:248:59: error:
  now Closed: https://github.com/timjb/aeson-schema/issues/9

pkgs/development/haskell-modules/configuration-common.nix:294:59: error:
  now Closed: https://github.com/bsl/GLFW-b/issues/50

pkgs/development/haskell-modules/configuration-common.nix:301:85: info:
  still Open: https://github.com/facebook/Haxl/issues/85

pkgs/development/haskell-modules/configuration-common.nix:330:35: warning:
  Url could not be reached: Url Https ("25" :| ["issues","lucid","chrisdone","repos","api.github.com"]): https://github.com/chrisdone/lucid/issues/25

pkgs/development/haskell-modules/configuration-common.nix:350:101: error:
  now Closed: https://github.com/lierdakil/pandoc-crossref/issues/199

pkgs/development/haskell-modules/configuration-common.nix:354:44: info:
  still Open: https://github.com/merijn/posix-pty/issues/12

pkgs/development/haskell-modules/configuration-common.nix:391:49: info:
  still Open: https://github.com/jgm/zip-archive/issues/57

pkgs/development/haskell-modules/configuration-common.nix:402:5: warning:
  Url could not be reached: Url Https ("28" :| ["issues","cmdtheline","eli-frey","repos","api.github.com"]): https://github.com/eli-frey/cmdtheline/issues/28

pkgs/development/haskell-modules/configuration-common.nix:405:5: info:
  still Open: https://github.com/bos/snappy/issues/1

pkgs/development/haskell-modules/configuration-common.nix:408:5: info:
  still Open: https://github.com/kim/snappy-framing/issues/3

pkgs/development/haskell-modules/configuration-common.nix:414:5: info:
  still Open: https://github.com/vincenthz/hs-crypto-pubkey/issues/20

pkgs/development/haskell-modules/configuration-common.nix:417:5: info:
  still Open: https://github.com/Philonous/xml-picklers/issues/5

pkgs/development/haskell-modules/configuration-common.nix:420:5: info:
  still Open: https://github.com/joeyadams/haskell-stm-delay/issues/3

pkgs/development/haskell-modules/configuration-common.nix:423:5: error:
  now Closed: https://github.com/cgaebel/stm-conduit/issues/33

pkgs/development/haskell-modules/configuration-common.nix:426:5: error:
  now Closed: https://github.com/pixbi/duplo/issues/25

pkgs/development/haskell-modules/configuration-common.nix:429:5: error:
  now Closed: https://github.com/evanrinehart/mikmod/issues/1

pkgs/development/haskell-modules/configuration-common.nix:432:5: info:
  still Open: https://github.com/basvandijk/threads/issues/10

pkgs/development/haskell-modules/configuration-common.nix:436:51: error:
  now Closed: https://github.com/tcrayford/rematch/issues/5

pkgs/development/haskell-modules/configuration-common.nix:437:51: info:
  still Open: https://github.com/tcrayford/rematch/issues/6

pkgs/development/haskell-modules/configuration-common.nix:448:5: error:
  now Closed: https://github.com/NixOS/nixpkgs/issues/6350

pkgs/development/haskell-modules/configuration-common.nix:451:5: error:
  now Closed: https://github.com/vincenthz/hs-asn1/issues/12

pkgs/development/haskell-modules/configuration-common.nix:471:5: error:
  now Closed: https://github.com/PaulJohnson/geodetics/issues/1

pkgs/development/haskell-modules/configuration-common.nix:474:5: info:
  still Open: https://github.com/junjihashimoto/test-sandbox-compose/issues/2

pkgs/development/haskell-modules/configuration-common.nix:477:5: error:
  now Closed: https://github.com/tych0/xcffib/issues/37

pkgs/development/haskell-modules/configuration-common.nix:480:5: info:
  still Open: https://github.com/afcowie/locators/issues/1

pkgs/development/haskell-modules/configuration-common.nix:492:5: info:
  still Open: https://github.com/ndmitchell/shake/issues/206

pkgs/development/haskell-modules/configuration-common.nix:493:5: error:
  now Closed: https://github.com/ndmitchell/shake/issues/267

pkgs/development/haskell-modules/configuration-common.nix:496:5: error:
  now Closed: https://github.com/nushio3/doctest-prop/issues/1

pkgs/development/haskell-modules/configuration-common.nix:500:7: info:
  still Open: https://github.com/karun012/doctest-discover/issues/22

pkgs/development/haskell-modules/configuration-common.nix:501:7: info:
  still Open: https://github.com/karun012/doctest-discover/issues/23

pkgs/development/haskell-modules/configuration-common.nix:520:5: error:
  now Closed: https://github.com/bos/aeson/issues/740

pkgs/development/haskell-modules/configuration-common.nix:524:5: error:
  now Closed: https://github.com/RaphaelJ/friday/issues/34

pkgs/development/haskell-modules/configuration-common.nix:531:5: error:
  now Closed: https://github.com/yaccz/saturnin/issues/3

pkgs/development/haskell-modules/configuration-common.nix:534:5: error:
  now Closed: https://github.com/kkardzis/curlhs/issues/6

pkgs/development/haskell-modules/configuration-common.nix:537:5: info:
  still Open: https://github.com/hvr/token-bucket/issues/3

pkgs/development/haskell-modules/configuration-common.nix:540:5: info:
  still Open: https://github.com/alphaHeavy/lzma-enumerator/issues/3

pkgs/development/haskell-modules/configuration-common.nix:543:5: error:
  now Closed: https://github.com/haskell-hvr/lzma/issues/14

pkgs/development/haskell-modules/configuration-common.nix:546:5: error:
  now Closed: https://github.com/BNFC/bnfc/issues/140

pkgs/development/haskell-modules/configuration-common.nix:563:5: error:
  now Closed: https://github.com/yesodweb/serversession/issues/1

pkgs/development/haskell-modules/configuration-common.nix:572:5: error:
  now Closed: https://github.com/hspec/mockery/issues/6

pkgs/development/haskell-modules/configuration-common.nix:575:5: error:
  now Closed: https://github.com/alphaHeavy/lzma-conduit/issues/5

pkgs/development/haskell-modules/configuration-common.nix:578:5: error:
  now Closed: https://github.com/kazu-yamamoto/logger/issues/42

pkgs/development/haskell-modules/configuration-common.nix:584:5: error:
  now Closed: https://github.com/liyang/thyme/issues/36

pkgs/development/haskell-modules/configuration-common.nix:587:5: error:
  now Closed: https://github.com/k0ral/hbro-contrib/issues/1

pkgs/development/haskell-modules/configuration-common.nix:602:5: error:
  now Closed: https://github.com/athanclark/sets/issues/2

pkgs/development/haskell-modules/configuration-common.nix:630:35: error:
  now Closed: https://github.com/kazu-yamamoto/ghc-mod/issues/335

pkgs/development/haskell-modules/configuration-common.nix:670:24: error:
  now Closed: https://github.com/chrisdone/hindent/issues/299

pkgs/development/haskell-modules/configuration-common.nix:673:5: info:
  still Open: https://github.com/bos/configurator/issues/22

pkgs/development/haskell-modules/configuration-common.nix:676:5: info:
  still Open: https://github.com/basvandijk/concurrent-extra/issues/12

pkgs/development/haskell-modules/configuration-common.nix:679:5: info:
  still Open: https://github.com/bos/bloomfilter/issues/7

pkgs/development/haskell-modules/configuration-common.nix:685:5: info:
  still Open: https://github.com/pxqr/base32-bytestring/issues/4

pkgs/development/haskell-modules/configuration-common.nix:688:5: error:
  now Closed: https://github.com/goldfirere/singletons/issues/122

pkgs/development/haskell-modules/configuration-common.nix:692:5: error:
  now Closed: https://github.com/haskell-crypto/cryptonite/issues/234

pkgs/development/haskell-modules/configuration-common.nix:694:43: info:
  still Open: https://github.com/haskell-crypto/cryptonite/issues/260

pkgs/development/haskell-modules/configuration-common.nix:726:5: error:
  now Closed: https://github.com/bos/math-functions/issues/25

pkgs/development/haskell-modules/configuration-common.nix:757:5: error:
  now Closed: https://github.com/pontarius/pontarius-xmpp/issues/105

pkgs/development/haskell-modules/configuration-common.nix:763:5: info:
  still Open: https://github.com/bmillwood/applicative-quoters/issues/6

pkgs/development/haskell-modules/configuration-common.nix:766:5: error:
  now Closed: https://github.com/roelvandijk/terminal-progress-bar/issues/13

pkgs/development/haskell-modules/configuration-common.nix:774:5: info:
  still Open: https://github.com/divipp/ActiveHs-misc/issues/10

pkgs/development/haskell-modules/configuration-common.nix:783:5: error:
  now Closed: https://github.com/mulby/diff-parse/issues/9

pkgs/development/haskell-modules/configuration-common.nix:786:5: info:
  still Open: https://github.com/josefs/STMonadTrans/issues/4

pkgs/development/haskell-modules/configuration-common.nix:792:5: error:
  now Closed: https://github.com/basvandijk/lifted-base/issues/34

pkgs/development/haskell-modules/configuration-common.nix:800:5: error:
  now Closed: https://github.com/basvandijk/case-insensitive/issues/24

pkgs/development/haskell-modules/configuration-common.nix:804:5: info:
  still Open: https://github.com/hvr/uuid/issues/28

pkgs/development/haskell-modules/configuration-common.nix:808:5: error:
  now Closed: https://github.com/ekmett/lens/issues/713

pkgs/development/haskell-modules/configuration-common.nix:811:5: error:
  now Closed: https://github.com/haskell/fgl/issues/60

pkgs/development/haskell-modules/configuration-common.nix:819:5: error:
  now Closed: https://github.com/dan-t/cabal-lenses/issues/6

pkgs/development/haskell-modules/configuration-common.nix:822:5: error:
  now Closed: https://github.com/fizruk/http-api-data/issues/49

pkgs/development/haskell-modules/configuration-common.nix:825:5: error:
  now Closed: https://github.com/diagrams/diagrams-lib/issues/288

pkgs/development/haskell-modules/configuration-common.nix:828:5: error:
  now Closed: https://github.com/danidiaz/streaming-eversion/issues/1

pkgs/development/haskell-modules/configuration-common.nix:831:5: error:
  now Closed: https://github.com/danidiaz/tailfile-hinotify/issues/2

pkgs/development/haskell-modules/configuration-common.nix:834:23: info:
  still Open: https://github.com/lymar/hastache/issues/46

pkgs/development/haskell-modules/configuration-common.nix:844:5: info:
  still Open: https://github.com/diagrams/diagrams-solve/issues/4

pkgs/development/haskell-modules/configuration-common.nix:857:5: info:
  still Open: https://github.com/takano-akio/filelock/issues/5

pkgs/development/haskell-modules/configuration-common.nix:883:17: info:
  still Open: https://github.com/haskell/c2hs/issues/192

pkgs/development/haskell-modules/configuration-common.nix:911:5: info:
  still Open: https://github.com/aisamanra/config-ini/issues/12

pkgs/development/haskell-modules/configuration-common.nix:925:9: error:
  now Closed: https://github.com/haskell/haddock/issues/679

pkgs/development/haskell-modules/configuration-common.nix:929:5: error:
  now Closed: https://github.com/alphaHeavy/protobuf/issues/34

pkgs/development/haskell-modules/configuration-common.nix:932:5: info:
  still Open: https://github.com/bos/text-icu/issues/32

pkgs/development/haskell-modules/configuration-common.nix:937:145: error:
  now Closed: https://github.com/tibbe/hashable/issues/95

pkgs/development/haskell-modules/configuration-common.nix:1038:5: error:
  now Closed: https://github.com/haskell-servant/servant-auth/issues/113

pkgs/development/haskell-modules/configuration-common.nix:1089:5: error:
  now Closed: https://github.com/haskell-hvr/hgettext/issues/14

pkgs/development/haskell-modules/configuration-common.nix:1118:30: error:
  now Closed: https://github.com/ku-fpg/blank-canvas/issues/73

pkgs/development/haskell-modules/configuration-common.nix:1132:5: error:
  now Closed: https://github.com/haskell/hoopl/issues/50

pkgs/development/haskell-modules/configuration-common.nix:1159:5: error:
  now Closed: https://github.com/danfran/cabal-macosx/issues/13

pkgs/development/haskell-modules/configuration-common.nix:1162:5: error:
  now Closed: https://github.com/DanielG/cabal-helper/issues/59

pkgs/development/haskell-modules/configuration-common.nix:1175:5: info:
  still Open: https://github.com/mgajda/json-autotype/issues/25

pkgs/development/haskell-modules/configuration-common.nix:1178:28: error:
  now Closed: https://github.com/phadej/tdigest/issues/30

pkgs/development/haskell-modules/configuration-common.nix:1202:25: info:
  still Open: https://github.com/jgm/pandoc/issues/5582

pkgs/development/haskell-modules/configuration-common.nix:1215:22: error:
  now Closed: https://github.com/haskell/haddock/issues/979

pkgs/development/haskell-modules/configuration-common.nix:1232:5: info:
  still Open: https://github.com/pruvisto/heap/issues/11

pkgs/development/haskell-modules/configuration-common.nix:1241:5: error:
  now Closed: https://github.com/sol/hpack/issues/366

pkgs/development/haskell-modules/configuration-common.nix:1247:5: info:
  still Open: https://github.com/elliottt/hsopenid/issues/15

pkgs/development/haskell-modules/configuration-common.nix:1264:5: error:
  now Closed: https://github.com/bitnomial/prometheus/issues/34

pkgs/development/haskell-modules/configuration-common.nix:1268:5: info:
  still Open: https://github.com/MichaelXavier/tasty-tap/issues/2

pkgs/development/haskell-modules/configuration-common.nix:1278:5: error:
  now Closed: https://github.com/erikd/hjsmin/issues/32

pkgs/development/haskell-modules/configuration-common.nix:1281:5: error:
  now Closed: https://github.com/blamario/grampa/issues/19

pkgs/development/haskell-modules/configuration-common.nix:1296:21: info:
  still Open: https://github.com/vmchale/atspkg/issues/12

pkgs/development/haskell-modules/configuration-common.nix:1327:5: info:
  still Open: https://github.com/Daniel-Diaz/HaTeX/issues/144

pkgs/development/haskell-modules/configuration-common.nix:1330:5: info:
  still Open: https://github.com/kazu-yamamoto/dns/issues/150

pkgs/development/haskell-modules/configuration-common.nix:1375:5: info:
  still Open: https://github.com/haskell-servant/servant-blaze/issues/17

pkgs/development/haskell-modules/configuration-common.nix:1378:5: info:
  still Open: https://github.com/haskell-servant/servant-ekg/issues/15

@peti I'm closing the issue. Right now I think that the documentation is correct.

Please, feel free to reopen it if you see possible improvements.