cube-js / cube-js/cube

Ignore some paths when deploying

Open
#10,976 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
20.8k
Forks
2.1k
Avg merge
1d 2h
Merged PRs (30d)
181

Description

## What

`cubejs-cli deploy` should ignore (not push) files at user-specified paths.

## Why

This is motivated by the following use-case scenarios:

- Miscellaneous files in a dirty working directory
- Dev scripts and test code which are never used at runtime

## How

A new command option `--ignore` will suffice.

```bash
cubejs-cli deploy --token=${CUBE_CLOUD_DEPLOY_TOKEN} --ignore "tests"
```

## Alternatives Considered

- A workaround exists: habitually move deploy-shy files out of the project directory.
- It would be nice if the command also ignored all paths specified by `.gitignore`. This is a bigger lift and may be considered a breaking change — build pipelines which deploy from a gitignored directory will no longer work.
- We could achieve this by introducing a `.cubeignore` file or some other config file in the project directory. Also a bigger lift than adding an `--ignore` option. Should be a non-breaking addition.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.