The hup package

[Tags:bsd2, library, program, test]

Upload packages or documentation to a hackage server

See README for details.


[Skip to Readme]

Properties

Versions 0.2.0.0
Dependencies base (>=4.2 && <5), bytestring (>=0.10.6.0), cmdargs, directory (>=1.2.2.0), filepath (>=1.4.0.0), http-client (>=0.4.26.2), http-client-tls (>=0.2.2), http-types (>=0.8.6), hup, mtl (>=2.2.1), shelly (>=1.6.5), split (>=0.2.2), tagsoup (>=0.13.6), tar (>=0.4.2.2), text (>=1.2.2.0), transformers (>=0.4.2.0), zlib (>=0.5.4.2) [details]
License BSD2
Copyright phlummox 2016, others where indicated
Author phlummox
Maintainer phlummox2@gmail.com
Category Distribution, Web, Documentation
Home page https://github.com/phlummox/hup
Source repository head: git clone https://github.com/phlummox/hup
Uploaded Wed Jan 4 10:30:21 UTC 2017 by phlummox
Updated Wed Jan 4 12:19:41 UTC 2017 by phlummox to revision 1
Distributions NixOS:0.2.0.0
Downloads 55 total (13 in the last 30 days)
Votes
0 []
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
enablewebtestsEnable tests that do a (pretty minimal) check by running an actual Warp web server. (Slower to build and run than other tests.)DisabledManual
patchhelpmessageUse patched version of cmdargs-0.10.14.1 with more informative help message. The patched version will need to be pulled from github (or a stack.yaml file must point to it) - see stack.yaml for details.DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for hup

Readme for hup-0.2.0.0

hup Hackage version Linux Build Status Windows Build Status

Small program for building and uploading packages and documentation built with stack to a hackage server; a Haskellified version of phadej's script, which is a stack-enabled version of ekmett's script.

In addition to stack, requires that cabal and haddock are on your path. (If you're using stack, they're easily installed with, e.g. stack install cabal-install.)

Installation

Install in the standard Haskell way: cabal install hup, or stack install hup.

Usage

  • hup [COMMAND] ... [OPTIONS]

    Build and/or upload packages or documentation to a hackage server. A server url should be of the format PROTOCOL://SERVER[:PORT]/, and defaults to https://hackage.haskell.org/ if not specified.

    A password can also be given in the PASSWORD environment variable instead of on the command line.

    'hup --help=all' will give help for all commands.

  • Commands:

      packup    Upload FILE as a package (or candidate package).
      docbuild  Build documentation for a  package.
      docup     Upload FILE as documentation.
      docboth   Build and upload documentation for a package.
    
  • Common flags:

      -v --verbose          be verbose
      -h --help             Display help message. '--help=all' will display help
                            for all commnds. '--help=bash' will output code for
                            bash command-line completion.
      -V --version          Print version information
         --numeric-version  Print just the version number
    
  • hup packup [OPTIONS] FILE
    Upload FILE as a package (or candidate package).

    Flags:

      -s --server=URL       
      -c --candidate        
      -u --user=USER        
      -p --password=PASSWORD  
    
  • hup docbuild [OPTIONS]
    Build documentation for a package.

    Flags:

      -e --executables             Run haddock for Executables targets
      -t --tests                   Run haddock for Test Suite targets
      -i --internal                Run haddock for internal modules and include
                                   all symbols
         --haddock-arguments=ARGS  extra args to pass to haddock
      -q --quick                   quick build - don't build docco for
                                   dependencies (links will be broken)
    
  • hup docup [OPTIONS] FILE
    Upload FILE as documentation.

    Flags:

      -s --server=URL       
      -c --candidate        
      -u --user=USER        
      -p --password=PASSWORD
    
  • hup docboth [OPTIONS]
    Build and upload documentation for a package.

    Flags:

      -e --executables             Run haddock for Executables targets
      -t --tests                   Run haddock for Test Suite targets
      -i --internal                Run haddock for internal modules and include
                                   all symbols
         --haddock-arguments=ARGS  extra args to pass to haddock
      -q --quick                   quick build - don't build docco for
                                   dependencies (links may be broken)
      -s --server=URL            
      -c --candidate             
      -u --user=USER             
      -p --password=PASSWORD      
    

Bash command-line completion

To enable bash command-completion:

Run

hup --help=bash > hup.complete

then either "source hup.complete" or ". hup.complete".

Defaults

Uses "https://hackage.haskell.org/" as the default server location, but see the DefaultServerUrl module if you want to patch this to something else before installing.

Bugs and limitations

  • Not yet tested on MS Windows or MacOS