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/lever-hiring).
12
7
13
-
### Installing the connector
14
-
15
-
From this connector directory, run:
16
-
```bash
17
-
poetry install --with dev
18
-
```
19
-
20
-
### Create credentials
21
-
22
-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/lever-hiring)
23
-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_lever_hiring/spec.yaml` file.
24
-
25
-
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
26
-
See `sample_files/sample_config.json` for a sample config file.
27
-
28
-
### Locally running the connector
29
-
30
-
```
31
-
poetry run source-lever-hiring spec
32
-
poetry run source-lever-hiring check --config secrets/config.json
33
-
poetry run source-lever-hiring discover --config secrets/config.json
34
-
poetry run source-lever-hiring read --config secrets/config.json --catalog integration_tests/configured_catalog.json
35
-
```
36
-
37
-
### Running tests
8
+
## Local development
38
9
39
-
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!
40
13
41
-
```
42
-
poetry run pytest tests
43
-
```
14
+
If you prefer to develop locally, you can follow the instructions below.
44
15
45
16
### Building the docker image
46
17
18
+
You can build any manifest-only connector with `airbyte-ci`:
An image will be available on your host with the tag `airbyte/source-lever-hiring:dev`.
55
28
29
+
### Creating credentials
30
+
31
+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/lever-hiring)
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
+
56
35
### Running as a docker container
57
36
58
-
Then run any of the connector commands as follows:
37
+
Then run any of the standard source connector commands:
59
38
60
-
```
39
+
```bash
61
40
docker run --rm airbyte/source-lever-hiring:dev spec
62
41
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-lever-hiring:dev check --config /secrets/config.json
63
42
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-lever-hiring: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):
70
49
71
50
```bash
72
51
airbyte-ci connectors --name=source-lever-hiring test
73
52
```
74
53
75
-
### Customizing acceptance Tests
76
-
77
-
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.
78
-
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.
79
-
80
-
### Dependency Management
81
-
82
-
All of your dependencies should be managed via Poetry.
83
-
To add a new dependency, run:
84
-
```bash
85
-
poetry add <package-name>
86
-
```
87
-
88
-
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
89
-
90
54
## Publishing a new version of the connector
91
55
92
-
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
93
-
94
-
1. Make sure your changes are passing our test suite:`airbyte-ci connectors --name=source-lever-hiring test`
95
-
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-lever-hiring`, 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-lever-hiring 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)):
96
60
- bump the `dockerImageTag` value in in `metadata.yaml`
97
-
- bump the `version` value in `pyproject.toml`
98
-
3. Make sure the `metadata.yaml` content is up to date.
99
61
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/lever-hiring.md`).
100
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).
101
63
6. Pat yourself on the back for being an awesome contributor.
0 commit comments