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

Source Intercom: Migrate to manifest only format with components #47240

Merged
merged 26 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
620f5eb
Source Intercom: migrate to manifest only
btkcodedev Oct 22, 2024
6800bbf
chore: auto-fix lint and format issues
octavia-squidington-iii Oct 22, 2024
efcdd3b
update docs
btkcodedev Oct 22, 2024
8bebea4
Merge branch 'master' into btkcodedev/intercomMigrateManifestOnly
btkcodedev Dec 9, 2024
b0d4537
Merge branch 'master' into btkcodedev/intercomMigrateManifestOnly
btkcodedev Dec 12, 2024
75c6c7c
update manifest
btkcodedev Dec 12, 2024
0921b3d
Merge branch 'master' into btkcodedev/intercomMigrateManifestOnly
btkcodedev Dec 12, 2024
bc85586
add stream hash after testing without custom components
btkcodedev Dec 12, 2024
f657d4d
test failing streams
btkcodedev Dec 12, 2024
0b17a7a
Merge branch 'master' into btkcodedev/intercomMigrateManifestOnly
btkcodedev Dec 12, 2024
e1b4716
update incremental parent
btkcodedev Dec 12, 2024
9b9daf9
update test scenarios
btkcodedev Dec 12, 2024
7714da3
change incremental dependency
btkcodedev Dec 15, 2024
d83859d
revert back custom components
btkcodedev Dec 16, 2024
cbc9a62
update incremental sync
btkcodedev Dec 16, 2024
d85b794
feat: re-implement unit tests
ChristoGrab Dec 16, 2024
d896f60
chore: version bump
ChristoGrab Dec 17, 2024
205ba72
update abnormal state values
btkcodedev Dec 17, 2024
2fc0c70
Merge branch 'btkcodedev/intercomMigrateManifestOnly' of https://gith…
btkcodedev Dec 17, 2024
fa00fd6
revert base image version bump due to failure
btkcodedev Dec 17, 2024
b60eda9
Merge branch 'master' into btkcodedev/intercomMigrateManifestOnly
DanyloGL Dec 17, 2024
53d4733
chore: disable unit tests and comment
ChristoGrab Dec 17, 2024
c7dc09f
chore: auto-fix lint and format issues
octavia-squidington-iii Dec 17, 2024
7577a5c
Update airbyte-integrations/connectors/source-intercom/metadata.yaml
ChristoGrab Dec 17, 2024
87849a9
Update airbyte-integrations/connectors/source-intercom/metadata.yaml
ChristoGrab Dec 17, 2024
3cc1013
chore: update changelog
ChristoGrab Dec 17, 2024
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
89 changes: 25 additions & 64 deletions airbyte-integrations/connectors/source-intercom/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,22 @@
# Intercom source connector

This is the repository for the Intercom source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/intercom).
This directory contains the manifest-only connector for `source-intercom`.
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.

## Local development

### Prerequisites

- Python (~=3.9)
- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)

### Installing the connector

From this connector directory, run:

```bash
poetry install --with dev
```

### Create credentials
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/intercom).

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/intercom)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_intercom/spec.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See `sample_files/sample_config.json` for a sample config file.

### Locally running the connector

```
poetry run source-intercom spec
poetry run source-intercom check --config secrets/config.json
poetry run source-intercom discover --config secrets/config.json
poetry run source-intercom read --config secrets/config.json --catalog integration_tests/configured_catalog.json
```
## Local development

### Running unit tests
We recommend using the Connector Builder to edit this connector.
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!

To run unit tests locally, from the connector directory run:

```
poetry run pytest unit_tests
```
If you prefer to develop locally, you can follow the instructions below.

### Building the docker image

You can build any manifest-only connector with `airbyte-ci`:

1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:

Expand All @@ -53,52 +26,40 @@ airbyte-ci connectors --name=source-intercom build

An image will be available on your host with the tag `airbyte/source-intercom:dev`.

### Creating credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/intercom)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.

### Running as a docker container

Then run any of the connector commands as follows:
Then run any of the standard source connector commands:

```
```bash
docker run --rm airbyte/source-intercom:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-intercom:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-intercom:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-intercom:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

### Running our CI test suite
### Running the CI test suite

You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):

```bash
airbyte-ci connectors --name=source-intercom test
```

### Customizing acceptance Tests

Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.

### Dependency Management

All of your dependencies should be managed via Poetry.
To add a new dependency, run:

```bash
poetry add <package-name>
```

Please commit the changes to `pyproject.toml` and `poetry.lock` files.

## Publishing a new version of the connector

You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?

1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-intercom test`
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
- bump the `dockerImageTag` value in in `metadata.yaml`
- bump the `version` value in `pyproject.toml`
3. Make sure the `metadata.yaml` content is up to date.
If you want to contribute changes to `source-intercom`, here's how you can do that:
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-intercom test`
3. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
- bump the `dockerImageTag` value in in `metadata.yaml`
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/intercom.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ test_strictness_level: high
acceptance_tests:
spec:
tests:
- spec_path: "source_intercom/spec.json"
- spec_path: "manifest.yaml"
connection:
tests:
- config_path: "secrets/config.json"
Expand Down
8 changes: 0 additions & 8 deletions airbyte-integrations/connectors/source-intercom/main.py

This file was deleted.

Loading
Loading