SYNOPSIS

       datalad-publish  [-h]  [-d  DATASET]  [--to  LABEL]  [--since  SINCE]  [--missing MODE] [-f] [--transfer-
              data TRANSFER_DATA] [-r] [--recursion-limit  LEVELS]  [--git-opts  STRING]  [--annex-opts  STRING]
              [--annex-copy-opts STRING] [-J NJOBS] [PATH [PATH ...]]

DESCRIPTION

       Publish a dataset to a known sibling.

       This  makes  the  last  saved state of a dataset available to a sibling or special remote data store of a
       dataset. Any target sibling must already exist and be known to the dataset.

       Optionally, it is possible to limit publication to change sets relative to a particular point in the ver‐
       sion history of a dataset (e.g. a release tag). By default, the state of the local dataset  is  evaluated
       against  the  last known state of the target sibling. Actual publication is only attempted if there was a
       change compared to the reference state, in order to speed up processing of large collections of datasets.
       Evaluation with respect to a particular "historic" state is only supported in conjunction with  a  speci‐
       fied reference dataset. Change sets are also evaluated recursively, i.e.  only those subdatasets are pub‐
       lished  where  a  change  was  recorded  that is reflected in to current state of the top-level reference
       dataset.  See "since" option for more information.

       Only publication of saved changes is supported. Any unsaved changes in a dataset (hierarchy) have  to  be
       saved before publication.

       NOTE   Power-user  info: This command uses git push, and git annex copy to publish a dataset. Publication
              targets are either configured remote Git repositories, or git-annex special remotes (if their sup‐
              port data upload).

OPTIONS

       PATH   path(s), that may point to file handle(s) to publish including their actual  content  or  to  sub‐
              dataset(s)  to be published. If a file handle is published with its data, this implicitly means to
              also publish the (sub)dataset it belongs to. '.' as a path is treated in  a  special  way  in  the
              sense,  that  it is passed to subdatasets in case RECURSIVE is also given. Constraints: value must
              be a string [Default: None]

       -h, --help, --help-np
              show this help message. --help-np forcefully disables the use of a pager for displaying  the  help
              message

       -d DATASET, --dataset DATASET
              specify  the  (top-level) dataset to be published. If no dataset is given, the datasets are deter‐
              mined based on the input arguments. Constraints: Value must be a Dataset or a valid identifier  of
              a Dataset (e.g. a path) [Default: None]

       --to LABEL
              name of the target sibling. If no name is given an attempt is made to identify the target based on
              the  dataset's  configuration (i.e. a configured tracking branch, or a single sibling that is con‐
              figured for publication). Constraints: value must be a string [Default: None]

       --since SINCE
              When publishing dataset(s), specifies commit (treeish, tag, etc) from which to look for changes to
              decide either updated publishing is necessary for this and which children. If  empty  argument  is
              provided,  then  we would take from the previously published to that remote/sibling state (for the
              current branch). Constraints: value must be a string [Default: None]

       --missing MODE
              action to perform, if a sibling does not exist in a given dataset. By default it  would  fail  the
              run  ('fail' setting). With 'inherit' a 'create-sibling' with '--inherit-settings' will be used to
              create sibling on the remote. With 'skip' - it simply will be skipped. Constraints: value must  be
              one of ('fail', 'inherit', 'skip') [Default: 'fail']

       -f, --force
              enforce  doing publish activities (git push etc) regardless of the analysis if they seemed needed.
              [Default: False]

       --transfer-data TRANSFER_DATA
              ADDME. Constraints: value must be one of ('auto', 'none', 'all') [Default: 'auto']

       -r, --recursive
              if set, recurse into potential subdataset. [Default: False]

       --recursion-limit LEVELS
              limit recursion into subdataset to the given number of levels. Constraints: value must be convert‐
              ible to type 'int' [Default: None]

       --git-opts STRING
              option string to be passed to git calls. Constraints: value must be a string [Default: None]

       --annex-opts STRING
              option string to be passed to git annex calls. Constraints: value must be a string [Default: None]

       --annex-copy-opts STRING
              option string to be passed to git annex copy calls. Constraints: value must be a string  [Default:
              None]

       -J NJOBS, --jobs NJOBS
              how  many  parallel  jobs  (where possible) to use. Constraints: value must be convertible to type
              'int', or value must be one of ('auto',) [Default: None]

AUTHORS

        datalad is developed by The DataLad Team and Contributors <team@datalad.org>.

datalad-publish 0.9.3                              2018-04-03                                 datalad-publish(1)