Skip to content

Commit bb49428

Browse files
authored
Source pivotal-tracker: Migrate to manifest-only (#44087)
1 parent 413ca9c commit bb49428

24 files changed

+4280
-4786
lines changed

airbyte-integrations/connectors/source-pivotal-tracker/README.md

+24-66
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,63 @@
1-
# Pivotal Tracker Source
1+
# Pivotal tracker source connector
22

3-
This is the repository for the Pivotal Tracker configuration based source connector.
4-
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/pivotal-tracker).
3+
This directory contains the manifest-only connector for `source-pivotal-tracker`.
4+
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
55

6-
## Local development
7-
8-
### Prerequisites
9-
10-
* Python (`^3.9`)
11-
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
12-
13-
14-
15-
### Installing the connector
16-
17-
From this connector directory, run:
18-
```bash
19-
poetry install --with dev
20-
```
21-
22-
23-
### Create credentials
24-
25-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/pivotal-tracker)
26-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` inside `manifest.yaml` file.
27-
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
28-
See `integration_tests/sample_config.json` for a sample config file.
29-
30-
31-
### Locally running the connector
32-
33-
34-
```
35-
poetry run source-pivotal-tracker spec
36-
poetry run source-pivotal-tracker check --config secrets/config.json
37-
poetry run source-pivotal-tracker discover --config secrets/config.json
38-
poetry run source-pivotal-tracker read --config secrets/config.json --catalog integration_tests/configured_catalog.json
39-
```
6+
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/pivotal-tracker).
407

41-
### Running tests
8+
## Local development
429

43-
To run tests locally, from the connector directory run:
10+
We recommend using the Connector Builder to edit this connector.
11+
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
12+
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!
4413

45-
```
46-
poetry run pytest tests
47-
```
14+
If you prefer to develop locally, you can follow the instructions below.
4815

4916
### Building the docker image
5017

18+
You can build any manifest-only connector with `airbyte-ci`:
19+
5120
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
5221
2. Run the following command to build the docker image:
22+
5323
```bash
5424
airbyte-ci connectors --name=source-pivotal-tracker build
5525
```
5626

5727
An image will be available on your host with the tag `airbyte/source-pivotal-tracker:dev`.
5828

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

6035
### Running as a docker container
6136

62-
Then run any of the connector commands as follows:
37+
Then run any of the standard source connector commands:
6338

64-
```
39+
```bash
6540
docker run --rm airbyte/source-pivotal-tracker:dev spec
6641
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-pivotal-tracker:dev check --config /secrets/config.json
6742
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-pivotal-tracker:dev discover --config /secrets/config.json
6843
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-pivotal-tracker:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
6944
```
7045

71-
### Running our CI test suite
46+
### Running the CI test suite
7247

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

7550
```bash
7651
airbyte-ci connectors --name=source-pivotal-tracker test
7752
```
7853

79-
### Customizing acceptance Tests
80-
81-
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.
82-
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.
83-
84-
### Dependency Management
85-
86-
All of your dependencies should be managed via Poetry.
87-
To add a new dependency, run:
88-
```bash
89-
poetry add <package-name>
90-
```
91-
92-
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
93-
9454
## Publishing a new version of the connector
9555

96-
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
97-
98-
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-pivotal-tracker test`
99-
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)):
56+
If you want to contribute changes to `source-pivotal-tracker`, here's how you can do that:
57+
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
58+
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-pivotal-tracker test`
59+
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)):
10060
- bump the `dockerImageTag` value in in `metadata.yaml`
101-
- bump the `version` value in `pyproject.toml`
102-
3. Make sure the `metadata.yaml` content is up to date.
10361
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/pivotal-tracker.md`).
10462
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).
10563
6. Pat yourself on the back for being an awesome contributor.

airbyte-integrations/connectors/source-pivotal-tracker/__init__.py

-3
This file was deleted.

airbyte-integrations/connectors/source-pivotal-tracker/acceptance-test-config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ connector_image: airbyte/source-pivotal-tracker:dev
44
acceptance_tests:
55
spec:
66
tests:
7-
- spec_path: "source_pivotal_tracker/spec.yaml"
7+
- spec_path: "manifest.yaml"
88
connection:
99
tests:
1010
- config_path: "secrets/config.json"

airbyte-integrations/connectors/source-pivotal-tracker/main.py

-8
This file was deleted.

0 commit comments

Comments
 (0)