John SJ Anderson > HiD > HiD::App::Command::publish

Download:
HiD-1.96.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.96   Source  

NAME ^

HiD::App::Command::publish - publish site

SYNOPSIS ^

    $ hid publish

    $ hid  # 'publish' is the default command...

    # publish directly to GitHub Pages
    $ hid publish --to_github_pages
    $ hid publist -G

DESCRIPTION ^

Processes files according to the active configuration and writes output files accordingly.

ATTRIBUTES ^

clean

Remove any existing site directory prior to the publication run

limit_posts

Limit the number of blog posts that will be written out. If you have a large number of blog posts that haven't changed, setting this can significantly speed up the publication process.

to_github_pages

If this option is set, the publishing process will switch to a 'gh-pages' branch in the current repository. If such a branch does not exist, a new "orphan" branch of that name will be created. Publication will happen in the normal destination directory, and then files will be moved into the root level of the repo and the destination directory removed. At the end of publication, all pending changes will be committed and a push (specifically, 'git push -u') will be done. Finally, the repository will be set back to whatever branch had been checked out before.

If this option is given and the current working directory is not the root level of a Git repository, an error will be thrown.

verbose

Be noisy. Primarily useful for debugging issues publishing to GitHub.

METHODS ^

get_config

Required for logging output, can be ignored by end users.

SEE ALSO ^

See HiD::App::Command for additional command line options supported by all sub commands.

VERSION ^

version 1.96

AUTHOR ^

John SJ Anderson <genehack@genehack.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2015 by John SJ Anderson.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: