Skip to content

Commit

Permalink
Viadot reorganization
Browse files Browse the repository at this point in the history
  • Loading branch information
k-wolski committed Feb 4, 2025
1 parent 31bb1dc commit 27ea13d
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CI
on:
pull_request:
branches:
- "2.0"
- "main"
workflow_dispatch:

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/detect-and-tag-new-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name: Detect and tag new version
on:
push:
branches:
- "2.0"
- "main"

workflow_dispatch:

Expand Down Expand Up @@ -50,4 +50,4 @@ jobs:
if: steps.check-tag.outputs.exists != 'true'
env:
GH_TOKEN: ${{ github.token }}
run: gh workflow run cd.yml -f version=v${{ steps.get-version.outputs.version }} --ref 2.0
run: gh workflow run cd.yml -f version=v${{ steps.get-version.outputs.version }} --ref main
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to contribute to `viadot2`
# How to contribute to `viadot`

## Installation & set up

Expand Down Expand Up @@ -94,18 +94,18 @@ Commit messages should:
4. Checkout a new branch

```console
# Make sure that your base branch is `2.0`.
git switch 2.0 && git checkout -b <name>
# Make sure that your base branch is `main`.
git switch main && git checkout -b <name>
```

5. Add your changes
6. Sync your fork with the `dyvenia` repo

```console
git remote add upstream https://github.com/dyvenia/viadot.git
git fetch upstream 2.0
git switch 2.0
git rebase upstream/2.0
git fetch upstream main
git switch main
git rebase upstream/main
```

7. Push the changes to your fork
Expand All @@ -114,7 +114,7 @@ Commit messages should:
git push --force
```

8. [Submit a PR](https://github.com/dyvenia/viadot/compare/2.0...main) into the `2.0` branch.
8. [Submit a PR](https://github.com/dyvenia/viadot/compare/yourbranch...main) into the `main` branch.

Make sure to read & check all relevant checkboxes in the PR description!

Expand Down Expand Up @@ -142,7 +142,7 @@ This will update the version in `pyproject.toml` accordingly.

#### Release

Once the modified `pyproject.toml` is merged to `2.0`, a version tag will be [automatically created](https://github.com/dyvenia/viadot/blob/2.0/.github/workflows/detect-and-tag-new-version.yml), and the [release workflow](https://github.com/dyvenia/viadot/blob/2.0/.github/workflows/cd.yml) will be triggered.
Once the modified `pyproject.toml` is merged to `main`, a version tag will be [automatically created](https://github.com/dyvenia/viadot/blob/main/.github/workflows/detect-and-tag-new-version.yml), and the [release workflow](https://github.com/dyvenia/viadot/blob/main/.github/workflows/cd.yml) will be triggered.

The release workflow will:

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

**Documentation**: <a href="https://dyvenia.github.io/viadot/" target="_blank">https://viadot.docs.dyvenia.com</a>

**Source Code**: <a href="https://github.com/dyvenia/viadot/tree/2.0" target="_blank">https://github.com/dyvenia/viadot/tree/2.0</a>
**Source Code**: <a href="https://github.com/dyvenia/viadot/tree/main" target="_blank">https://github.com/dyvenia/viadot/tree/main</a>

---

Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide/contributing_to_viadot.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## How to contribute

Before creating a PR, make sure to familiarize yourself with the [Contributing Guide](https://github.com/dyvenia/viadot/blob/2.0/CONTRIBUTING.md).
Before creating a PR, make sure to familiarize yourself with the [Contributing Guide](https://github.com/dyvenia/viadot/blob/main/CONTRIBUTING.md).

## Next steps

Expand Down
4 changes: 2 additions & 2 deletions docs/developer_guide/creating_a_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ __all__ = [

## Sources using optional dependencies

In case your source uses an [optional dependency](https://github.com/dyvenia/viadot/blob/2.0/pyproject.toml), you need to escape the import. In the example below, our source uses the optional `adlfs` package (part of the `azure` extra):
In case your source uses an [optional dependency](https://github.com/dyvenia/viadot/blob/main/pyproject.toml), you need to escape the import. In the example below, our source uses the optional `adlfs` package (part of the `azure` extra):

```python hl_lines="5-8"
# sources/azure_data_lake.py
Expand Down Expand Up @@ -318,4 +318,4 @@ This will pass the `credentials` key, including the `api_key` secret, to the ins

And that's all you need to know to create your own `viadot` connectors!

If you need inspiration, take a look at some of the [existing sources](https://github.com/dyvenia/viadot/blob/2.0/src/viadot/sources/).
If you need inspiration, take a look at some of the [existing sources](https://github.com/dyvenia/viadot/blob/main/src/viadot/sources/).
4 changes: 2 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ rye sync --features=sap
### Library

```console
git clone https://github.com/dyvenia/viadot.git -b 2.0 && \
git clone https://github.com/dyvenia/viadot.git && \
cd viadot && \
rye sync
```
Expand All @@ -89,7 +89,7 @@ git clone https://github.com/dyvenia/viadot.git -b 2.0 && \
pip install viadot2
```

or, with the `azure` [extra](https://github.com/dyvenia/viadot/blob/2.0/pyproject.toml) as an example:
or, with the `azure` [extra](https://github.com/dyvenia/viadot/blob/main/pyproject.toml) as an example:

```console
pip install viadot2[azure]
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "viadot2"
version = "2.1.30"
version = "2.2.0"
description = "A simple data ingestion library to guide data flows from some places to other places."
authors = [
{ name = "acivitillo", email = "[email protected]" },
Expand Down
2 changes: 1 addition & 1 deletion src/viadot/examples/sap_rfc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Note that we refer to a `sap_netweaver_rfc` folder in the Dockerfile. This is th
Clone the viadot, enter the sap_rfc folder, and build the image:

```console
git clone --branch 2.0 https://github.com/dyvenia/viadot.git && \
git clone --branch main https://github.com/dyvenia/viadot.git && \
cd viadot/viadot/examples/sap_rfc && \
docker build -t viadot:sap_rfc . --no-cache
```
Expand Down

0 comments on commit 27ea13d

Please sign in to comment.