hup: Upload packages or documentation to a hackage server

[ bsd2, distribution, documentation, library, program, web ] [ Propose Tags ]

Upload packages or documentation to a hackage server

See README for details.


[Skip to Readme]
Versions [faq] 0.2.0.0, 0.3.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 BSD-2-Clause
Copyright phlummox 2016, others where indicated
Author phlummox
Maintainer phlummox2@gmail.com
Revised Revision 1 made by phlummox at Wed Jan 4 12:19:41 UTC 2017
Category Distribution, Web, Documentation
Home page https://github.com/phlummox/hup
Source repo head: git clone https://github.com/phlummox/hup
Uploaded by phlummox at Wed Jan 4 10:30:21 UTC 2017
Distributions NixOS:0.3.0.0
Executables hup
Downloads 731 total (38 in the last 30 days)
Rating 1.75 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Flags

NameDescriptionDefaultType
enablewebtests

Enable tests that do a (pretty minimal) check by running an actual Warp web server. (Slower to build and run than other tests.)

DisabledManual
patchhelpmessage

Use 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

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hup-0.2.0.0

[back to package description]

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