Skip to content
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.

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

Add version to config and contract #1938 #65

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Initializes a new Dozer project by generating the foundational `dozer-config.yam
#### `dozer live`
Initiates an in-browser interface for real-time Dozer application development. As the source code is modified in the IDE, changes are immediately reflected in this interface, enabling instant visualization and interactive testing. It streamlines the feedback loop, offering insights into data flows, configurations, and endpoints, all within the context of the live application.

#### `dozer run`
Initiates Dozer in a non-interactive way, but starting both `app` and `api` as different threads of the same process.
#### `dozer run [--locked]`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should explain what --locked is for

Initiates Dozer in a non-interactive way, but starting both `app` and `api` as different threads of the same process. It is optional the `--locked` flag to `dozer run`.

## Self-Hosted Deployment

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ home_dir: ./.dozer_custom
Determines the name of the Dozer application.
**Type**: String

#### `app_name`
#### `version`
Determines the version of the Dozer application.
**Type**: Integer

Expand Down
1 change: 1 addition & 0 deletions docs/getting_started/core/connecting-to-sources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ Now edit your `dozer-config.yaml` and add a new PostgreSQL connection, a new sou
```yaml
cache_max_map_size: 10000000000
app_name: ny-taxi-sample
version: 1
connections:
- config: !LocalStorage
details:
Expand Down
1 change: 1 addition & 0 deletions docs/sources/ethereum.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Traces provide a step-by-step account of all operations in a transaction, from g
### Configuration
```yaml
app_name: dozer-eth-dashboard
version: 1
connections:
- config: !Ethereum
provider: !Trace
Expand Down
1 change: 1 addition & 0 deletions static/examples/1_hypercharge_postgres/dozer-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
app_name: postgres-sample
version: 1
connections:
- config: !Postgres
user: postgres
Expand Down
1 change: 1 addition & 0 deletions static/examples/2_eth_stats_sample/dozer-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
app_name: eth-smartcontracts-sample
version: 1
connections:
- config: !Ethereum
provider: !Log
Expand Down
1 change: 1 addition & 0 deletions static/examples/3_snowflake_sample/dozer-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
app_name: snowflake-tutorial
version: 1
connections:
- config: !Snowflake
server: "{{SN_SERVER}}"
Expand Down
1 change: 1 addition & 0 deletions static/examples/4_supabase_s3/dozer-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
app_name: aws-s3-sample
version: 1
connections:
- config : !S3Storage
details:
Expand Down