You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/freshdesk).
21
7
22
-
### Create credentials
23
-
24
-
**If you are a community contributor**, follow the instructions in the
25
-
[documentation](https://docs.airbyte.com/integrations/sources/freshdesk) to generate the necessary
26
-
credentials. Then create a file `secrets/config.json` conforming to the `source_freshdesk/spec.yaml`
27
-
file. Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there
28
-
is no danger of accidentally checking in sensitive information. See
29
-
`sample_files/sample_config.json` for a sample config file.
30
-
31
-
### Locally running the connector
32
-
33
-
```
34
-
poetry run source-freshdesk spec
35
-
poetry run source-freshdesk check --config secrets/config.json
36
-
poetry run source-freshdesk discover --config secrets/config.json
37
-
poetry run source-freshdesk read --config secrets/config.json --catalog sample_files/configured_catalog.json
38
-
```
39
-
40
-
### Running unit tests
8
+
## Local development
41
9
42
-
To run unit 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!
43
13
44
-
```
45
-
poetry run pytest unit_tests
46
-
```
14
+
If you prefer to develop locally, you can follow the instructions below.
An image will be available on your host with the tag `airbyte/source-freshdesk:dev`.
59
28
29
+
### Creating credentials
30
+
31
+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/freshdesk)
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.
34
+
60
35
### Running as a docker container
61
36
62
-
Then run any of the connector commands as follows:
37
+
Then run any of the standard source connector commands:
63
38
64
-
```
39
+
```bash
65
40
docker run --rm airbyte/source-freshdesk:dev spec
66
41
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-freshdesk:dev check --config /secrets/config.json
67
42
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-freshdesk:dev discover --config /secrets/config.json
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
75
49
76
50
```bash
77
51
airbyte-ci connectors --name=source-freshdesk test
78
52
```
79
53
80
-
### Customizing acceptance Tests
81
-
82
-
Customize `acceptance-test-config.yml` file to configure acceptance tests. See
[semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
106
-
- bump the `dockerImageTag` value in in `metadata.yaml`
107
-
- bump the `version` value in `pyproject.toml`
108
-
3. Make sure the `metadata.yaml` content is up to date.
109
-
4. Make sure the connector documentation and its changelog is up to date
If you want to contribute changes to `source-freshdesk`, 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-freshdesk 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)):
60
+
- bump the `dockerImageTag` value in in `metadata.yaml`
61
+
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/freshdesk.md`).
62
+
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).
113
63
6. Pat yourself on the back for being an awesome contributor.
114
64
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
115
-
8. Once your PR is merged, the new version of the connector will be automatically published to
116
-
Docker Hub and our connector registry.
65
+
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
0 commit comments