prepare_git_example_from_source
which can be used to generate a git controlled orderly directory
from a source, and another entrypoint run_orderly_demo
that exposes this function, for use in testing OrderlyWeb (mrc-3665)orderly_cancel_remote
which can be used to cancel one or more reports running on a remote via its key (mrc-3167).git
directory is found at the orderly root (vimc-4866)rm(list = ls())
(or similar) at the top of scripts as this leads to hard-to-track errors, modifies the global environment and is generally poor practice (vimc-4810)recursive = FALSE
to orderly::orderly_pull_archive
and orderly::orderly_pull_dependencies
. This can reduce the total amount of data transferred when you do not care as much about the integrity of the local archive (vimc-4320)orderly_workflow
in favour of supporting workflows through orderly.server (mrc-2275)orderly_remote_status
to return details of currently running and queued reports on the remote queue.orderly_graph
arg max_depth
now truncates depth of the tree instead of throwing error and arg recursion_limit
added which works how max_depth
used toorderly_info
which returns details from report runs, both successful and failed (VIMC-4619)orderly_run
, orderly_run_internal
and bundle_run
will now save a orderly_fail.rds
if run fails containing metadata and info about failure reason (VIMC-4037)orderly_cleanup
will now sanitise the report name passed to itorderly_cleanup
will now print summary of how many items will be deleted (#265)orderly_run_remote
checks that ref exists before running (VIMC-4574)orderly_run
with non-boolean use_draft
and fixed ID dependency works (#259)orderly_pull_archive
is now more tolerant of trailing slashes (#260)orderly_bundle_pack_remote
and orderly_bundle_import_remote
which create a bundle from a remote and return the completed bundle back to the remote (VIMC-4457)orderly_bundle_import
to accept a filename that has been renamed from <id>.zip
. While this is not generally desirable, it may be needed for some workflows (VIMC-4382)orderly_bundle_pack
failed when the orderly tree and temporary directory were on different filesystems (VIMC-4354)orderly_bundle_run
failed when using a relative path for a working directory (VIMC-4337)orderly::orderly_new()
works in an orderly repo that does not (yet) have a src/
directory (VIMC-4032)orderly::orderly_runner
which has been moved to vimc/orderly.server
(VIMC-4073)orderly::orderly_config
to return an object representing the config (VIMC-4048)orderly::orderly_bundle_pack
, orderly::orderly_bundle_run
and orderly::orderly_bundle_import
. This interface will be expanded and the interface may change somewhat (VIMC-3825)get_report_parameters
to list parameters for a report at a particular commit id (VIMC-3953)get_reports
to list reports available for a particular branch and commit from orderly_runner (VIMC-3945)git_commits
to list commits for a particular branch from orderly_runner (VIMC-3941)git_branches_no_merged
to get unmerged branches from orderly_runner (VIMC-3857)orderly.log
after a failed run; this primarily impacts the cli runner and then primarily when being run in parallel where the log is not printed to screen (VIMC-3841)orderly::orderly_workflow
allows users to run a "workflow" - a list of reports which to be run in order. Workflows are configured via a yml file in workflows/
directory.orderly::orderly_data()
has been removed as do not believe anyone was using it, and it is superseded by orderly::orderly_develop_start()
(VIMC-3611)orderly::orderly_run
(id_file
, batch_id
, ref
and fetch
). These were not intended for direct use by users (VIMC-3539)orderly::orderly_pull_dependencies()
works where the dependencies use query ids, and orderly::orderly_pull_archive()
accepts query ids (rather than just latest
) as an argument (VIMC-3789)orderly::orderly_run_remote()
takes an instance argument to allow users to specify the source DB (VIMC-3698)orderly::orderly_push_archive()
which allows pushing of an archive to a remote. The orderly::orderly_remote_path
remote supports this, though care should be taken with what you push! (VIMC-3784)orderly::orderly_rebuild()
creates a dated backup of the database before running, allowing this potentially destructive operation to be recovered from (VIMC-3702)orderly::orderly_develop_clean()
no longer deletes artefacts that are re-exported from sources (VIMC-3671, reported by @cewalters)orderly::orderly_develop_start()
to use environment variables declared in orderly.yml
and defined in orderly_envir.yml
(#214, VIMC-3669, reported by @sangeetabhatia03)orderly batch
using a csv file via --file
(VIMC-3569)orderly::orderly_remote()
for getting an "orderly remote" object, as declared in the orderly_config.yml
(VIMC-3655)orderly::orderly_batch
and with the CLI as orderly batch
(VIMC-3603)orderly::orderly_run
and orderly::orderly_pull_dependenices
(VIMC-3512, #170)orderly::orderly_search
or when declaring dependencies (VIMC-3538)environment:
field in orderly.yml
(VIMC-3558)orderly_envir.yml
are available during report run (#180, VIMC-3530).gitignore
files with orderly::orderly_use_gitignore
(VIMC-3513, reported by @jeffeaton)orderly::orderly_develop_*
functions are now permissive and allow some invalid orderly.yml
to continue - in particular, the partially complete template generated by orderly::orderly_new
can be directly used (VIMC-3510)usethis
inspired functions orderly::orderly_use_resource()
, orderly::orderly_use_source()
and orderly::orderly_use_package()
which can add a resource, source or packages into the orderly.yml (VIMC-3503)orderly_develop_start
, orderly_develop_status
and orderly_develop_clean
. These largely supersede orderly_test_start
, though the latter remains for now (VIMC-3404)use_draft = "newer"
, no longer pulls in failed drafts (VIMC-3467, reported by @sangeetabhatia03)pull
sub command for pulling dependencies from remote orderly servers (VIMC-3466)--instance
argument (VIMC-3460)orderly_run.rds
. This is not yet reflected in the database and might be tweaked before being added.use_draft
to orderly_run
and orderly_test_start
. This will replace the use of explicitly specifying draft: true
in the depends section of orderly.yml
(VIMC-3377).orderly::orderly_run
, orderly::orderly_db
, orderly::orderly_test_start
and orderly::orderly_data
all get an instance
argument to support this (VIMC-3302)..Random.seed
, if present (VIMC-3375)orderly::orderly_test_start
prints instructions that are paste-able on windows -- previously they may have contained backslashes (VIMC-3251).orderly::orderly_run
now strips a leading src/
if provided, allowing easier tab-completion of report names (VIMC-3226).orderly::orderly_test_check
is no longer case sensitive with paths, preventing issues when used from directories that do not have canonical casing (VIMC-3205)orderly::orderly_test_start
and related functions has been severely reduced. Functions orderly::orderly_test_end
and orderly::orderly_test_restart
have been removed and orderly::orderly_test_start
no longer directly provides a useable environment for testing reports (VIMC-3178).orderly.yml
, and the format has altered slightly (VIMC-2413, #8).pull_archive
, pull_dependencies
, set_default_remote
have been removed (VIMC-2946, deprecated in VIMC-2944 / 0.7.2).orderly_migrate
can now clean up old migration backup files. These should generally be quite safe to delete, but it would be better to do this directly from orderly
(VIMC-3157)orderly
archive using orderly::orderly_deduplicate
(VIMC-731).orderly_run
now checks for sink imbalance, in the same way that device imbalances are currently checked for, preventing odd errors when sinks are left open or too many are closed (VIMC-3129)orderly
db, and also pulls all dependent reports (VIMC-2855, VIMC-3054).orderly_config.yml
now has an "args" section, rather than guessing arguments. Old configurations are valid, with a warning to update (VIMC-1986).orderly_unzip_archive
/ unzip_archive
has been removed in preparation for release.push_archive
(previously marked as experimental and not implemented for anything other than file remotes) has been removed. We may reconsider this again in the future.pull_archive
and pull_dependencies
have been deprecated in favour of orderly_pull_archive
and orderly_pull_dependencies
(respectively). Similarly, set_default_remote
becomes orderly_default_remote_set
and orderly_default_remote_get
is exported. unzip_archive
becomes orderly_unzip_archive
(VIMC-2944).open
and extended_output
from orderly_run
as these were not widely used (VIMC-2945)orderly
in preparation for it to be implemented entirely in OrderlyWeb
(in the meantime it will be provided by orderly.server
(VIMC-2941)custom_fields
(holding metadata about the fields) and report_version_custom_fields
(linking these to the report versions) (VIMC-2768)orderly
"runner" (orderly_runner
) will now periodically backup the destination database, which will be useful in cases where other applications store information in it (VIMC-2882)config
argument to exported functions has been renamed to root
to better reflect what is expected to be passed in (VIMC-2919)orderly_run.yml
script has now been removed and orderly_run.rds
is the sole source of truth for the orderly
run metadata (VIMC-2873).orderly
configuration (VIMC-2795)README.md
files are automatically copied as resources from source folder. Additionally it is an error to include README.md
as an artefact (VIMC-2230)timeout
through to remote runners when using the montagu
package (VIMC-2517)master_only
configuration option and can prevent running reports with references other than master
. This is now enforced entirely on the server (VIMC-2642)changelog
table includes the attributable public report version attributable to each changelog entryorderly
now prompts to install missing packages and offers code to help with this (VIMC-2384)orderly run
on the command line accepts message entries (VIMC-2363, VIMC-1797)orderly
checks that the resources were not modified during running a report (VIMC-2137)README.md
is automatically treated as resource if present (VIMC-2230)montagu
package is no longer used directly by orderly
(VIMC-2453) - instead we use a similar "driver" approach to the database connections. This paves the way for an eventual CRAN release (VIMC-2421).orderly
now indicates the version that failed to run, and can move failed versions aside to complete migration of the rest of an archive.vaultr
0.2.0, which is a major overhaul of that package.orderly
archive (VIMC-1761)orderly
database (VIMC-2397)orderly
works with report repository clones that lack an archive
directory (VIMC-2383)displayname
and description
fields are correctly copied into the new orderly
database.connection
column in the report_version
table in orderly
's database (VIMC-2327)latest
column in the report
table in orderly
's database (VIMC-2298)orderly_envir.yml
published
field (VIMC-2251)if_schema_changed
to rebuild orderly
database (orderly_rebuild
) only on a schema change (VIMC-2280)orderly_test_start
fails on startup (VIMC-1870)orderly::orderly_run_info
(#24/VIMC-1818)orderly/template.yml
within the orderly
root if available, then falling back on the version in the package.push_archive
, the inverse of pull_archive
for copying an archive report elsewhere (VIMC-1811). Currently only supported for remote
as a path.orderly::orderly_run_info()
can return information about the current run, including information on dependencies.orderly_run
gains a --fetch
argument, used when --ref
is specified to run git fetch
before resolving ref
orderly
runner looks up the sha
for a ref
at the point of queuing, rather than the point of running--pull
and --fetch
argumentserver
argument to pull_dependencies
and pull_report
changes to remote
. The structure here will probably change a little further in a future version.Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.