Skip to content

Commit

Permalink
Update migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
askarpets committed Jun 4, 2024
1 parent 782e243 commit 15824b0
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 15 deletions.
8 changes: 5 additions & 3 deletions airbyte-integrations/connectors/source-asana/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ data:
releases:
breakingChanges:
1.0.0:
message: "This release introduces updated data type of the `name` field in the `events` stream. Users will need to reset this stream after upgrading. Please see migration guide for more details."
upgradeDeadline: "2024-06-30"
message:
"This verison migrates the Asana connector to the low-code framework for greater maintainability.
!! Important: A bug in the events stream schema has been fixed."
scopedImpact:
- scopeType: stream
impactedScopes:
- events
remoteRegistries:
pypi:
enabled: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2139,10 +2139,6 @@ definitions:
additionalProperties: true
type: object
properties:
"type":
type:
- "null"
- string
gid:
type:
- "null"
Expand Down Expand Up @@ -2274,6 +2270,10 @@ definitions:
type:
- "null"
- string
type:
type:
- "null"
- string

organization_exports_schema:
$schema: http://json-schema.org/draft-07/schema#
Expand Down Expand Up @@ -2324,10 +2324,6 @@ definitions:
additionalProperties: true
type: object
properties:
"type":
type:
- "null"
- string
user:
type:
- "null"
Expand Down Expand Up @@ -2362,6 +2358,10 @@ definitions:
type:
- "null"
- string
type:
type:
- "null"
- string
action:
type:
- "null"
Expand Down
55 changes: 53 additions & 2 deletions docs/integrations/sources/asana-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,57 @@

## Upgrading to 1.0.0

The verison migrates the Asana connector to the low-code framework for greater maintainability.
Important: A bug in the events stream schema['properties']['name'] has been fixed to string.
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte.
As part of our commitment to delivering exceptional service, we are transitioning source Pinterest from the Python Connector Development Kit (CDK) to our innovative low-code framework.
This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog.
However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

This release introduces updated data type of the `name` field in the `events` stream. Users will need to reset this stream after upgrading.

## Connector Upgrade Guide

### For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

1. Select **Settings** in the main navbar.
1. Select **Sources**.
2. Find Gitlab in the list of connectors.

:::note
You will see two versions listed, the current in-use version and the latest version available.
:::

3. Select **Change** to update your OSS version to the latest available version.

### Update the connector version

1. Select **Sources** in the main navbar.
2. Select the instance of the connector you wish to upgrade.

:::note
Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
:::

3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### Refresh affected schemas and reset data

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab. 1. Select **Refresh source schema**. 2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page. 1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::

For more information on resetting your data in Airbyte, see [this page](/operator-guides/clear).

4 changes: 2 additions & 2 deletions docs/integrations/sources/asana.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ The connector is restricted by [Asana rate limits](https://developers.asana.com/
## Changelog

| Version | Date | Pull Request | Subject |
| :------ | :--------- | :------------------------------------------------------- | :---------------------------------------------------------------- |
|:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------------------------|
| 1.0.0 | 2024-04-15 | [36697](https://github.com/airbytehq/airbyte/pull/36697) | Migrate to low code |
| 0.6.1 | 2023-11-13 | [31110](https://github.com/airbytehq/airbyte/pull/31110) | Fix hidden config access |
| 0.6.1 | 2023-11-13 | [31110](https://github.com/airbytehq/airbyte/pull/31110) | Fix hidden config access |
| 0.6.0 | 2023-11-03 | [31110](https://github.com/airbytehq/airbyte/pull/31110) | Add new stream Portfolio Memberships with Parent Portfolio |
| 0.5.0 | 2023-10-30 | [31114](https://github.com/airbytehq/airbyte/pull/31114) | Add Portfolios stream |
| 0.4.0 | 2023-10-24 | [31084](https://github.com/airbytehq/airbyte/pull/31084) | Add StoriesCompact stream |
Expand Down

0 comments on commit 15824b0

Please sign in to comment.