Skip to content

docs: run: add --always-changed flag #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2019
Merged

docs: run: add --always-changed flag #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions static/docs/commands-reference/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ usage: dvc run [-h] [-q | -v] [-d DEPS] [-o OUTS] [-O OUTS_NO_CACHE]
[-m METRICS] [-M METRICS_NO_CACHE] [-f FILE] [-c CWD]
[-w WDIR] [--no-exec] [-y] [--overwrite-dvcfile]
[--ignore-build-cache] [--remove-outs] [--no-commit]
[--always-changed]
command

positional arguments:
Expand Down Expand Up @@ -143,6 +144,10 @@ pipeline.

> The `dvc status` command will mention that the file is `not in cache`.

- `--always-changed` - always consider this DVC-file as changed. As a result
`dvc status` will report it as `always changed` and `dvc repro` will always
run it.

- `-h`, `--help` - prints the usage/help message, and exit.

- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
Expand Down
5 changes: 3 additions & 2 deletions static/docs/commands-reference/status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ outputs described in it.
(e.g. someone manually edited the file).

- _always changed_ means that this is a special DVC-file with no dependencies
(orphans), which is considered always changed and is always executed by
`dvc repro`.
(orphans) or it has `always_changed: true` option set (see
[`--always-changed` flag for `dvc run`](/doc/commands-reference/run)), which
is considered always changed and is always executed by `dvc repro`.

- _changed deps_ or _changed outs_ means that there are changes in dependencies
or outputs defined by the <abbr>DVC-file</abbr>. Depending on the use case,
Expand Down
3 changes: 3 additions & 0 deletions static/docs/user-guide/dvc-file-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ the highlighting for your editor.
Here is a sample DVC-file:

```yaml
always_changed: true
locked: true
cmd: python cmd.py input.data output.data metrics.json
deps:
Expand Down Expand Up @@ -51,6 +52,8 @@ On the top level, `.dvc` file consists of these fields:
- `md5`: md5 checksum for this DVC-file
- `locked`: Whether or not this stage is locked from reproduction
- `wdir`: Directory to run command in (default `.`)
- `always_changed`: Whether or not this stage should always be considered as
changed by commands such as `dvc status` and `dvc repro` (default `false`)

A dependency entry consists of a pair of fields:

Expand Down