# velocirepo check-heartbeat


Check with GitHub's Actions API that the nightly workflow started its scheduled run since it was last due; a run in progress counts, manual runs don't. When it didn't, comment on the tracking issue, or open it, and fail. After the issue has been open for three days, it escalates once. The schedule is read from the workflow file. Uses the workflow token, from `--repo-token` or VELOCIREPO_REPO_TOKEN, with issues: write and actions: read.


``` bash
velocirepo check-heartbeat [OPTIONS]
```


<span class="gd-details-chevron" aria-hidden="true"></span>Full --help output


    Check with GitHub's Actions API that the nightly workflow started its scheduled run since it was last due; a run in progress counts, manual runs don't. When it didn't, comment on the tracking issue, or open it, and fail. After the issue has been open for three days, it escalates once.

    The schedule is read from the workflow file. Uses the workflow token, from --repo-token or VELOCIREPO_REPO_TOKEN, with issues: write and actions: read.

    Usage:
      velocirepo check-heartbeat [flags]

    Flags:
      -h, --help                   help for check-heartbeat
          --repo string            the data repository, owner/name (default: $GITHUB_REPOSITORY)
          --repo-token string      a token for the data repository (default: $VELOCIREPO_REPO_TOKEN)
          --workflow string        the nightly workflow's file name (default "velocirepo.yml")
          --workflows-dir string   where the workflow files are (default ".github/workflows")

    Global Flags:
          --config string   config file (default: walk up for velocirepo.toml)
      -q, --quiet           suppress progress output
      -v, --verbose         enable debug logging


## Options


`-h, --help`  
help for check`-h`eartbeat

`--repo: string = $GITHUB_REPOSITORY`  
the data repository, owner/name

`--repo-token: string = $VELOCIREPO_REPO_TOKEN`  
a token for the data repository

`--workflow: string = velocirepo.yml`  
the nightly workflow's file name

`--workflows-dir: string = .github/workflows`  
where the workflow files are

`--config: string = walk up for velocirepo.toml`  
config file

`-q, --quiet`  
suppress progress output

`-v, --verbose`  
enable debug logging