Skip to content

Commit ced5309

Browse files
authored
Update README.md (#23505)
1 parent 5e1b90f commit ced5309

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/connector-development/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,22 @@ Once you've finished iterating on the changes to a connector as specified in its
160160
* `airbyte-config/init/src/main/resources/seed/destination_definitions.yaml` if it is a destination.
161161

162162
* Then run the command `./gradlew :airbyte-config:init:processResources` to generate the seed spec yaml files, and commit the changes to the PR. See [this readme](https://github.com/airbytehq/airbyte/tree/a534bb2a8f29b20e3cc7c52fef1bc3c34783695d/airbyte-config/specs) for more information.
163-
164-
5. If the `README.md` file of the connector contains a `Changelog` section, add the new version and relevant release information to the table in the section.
165-
6. The new version of the connector is now available for everyone who uses it. Thank you!
163+
164+
5. The new version of the connector is now available for everyone who uses it. Thank you!
165+
166+
167+
### Updating Connector Metadata
168+
169+
When a new (or updated version) of a connector is ready to be published, our automations will check your branch for a few things:
170+
* Does the connector have an icon?
171+
* Does the connector have documentation and is it in the proper format?
172+
* Does the connector have a changelog entry for this version?
173+
174+
If any of the above are failing, you won't be able to merge your PR or publish your connector.
175+
176+
Connector icons should be square SVGs and be located in [this directory](https://github.com/airbytehq/airbyte/tree/master/airbyte-config/init/src/main/resources/icons).
177+
178+
Connector documentation and changelogs are markdown files which live either [here for sources](https://github.com/airbytehq/airbyte/tree/master/docs/integrations/sources), or [here for destinations](https://github.com/airbytehq/airbyte/tree/master/docs/integrations/destinations).
166179

167180
### The /publish command
168181

0 commit comments

Comments
 (0)