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 Freshservice: add requested_items stream #34272

Merged
merged 3 commits into from
Jan 16, 2024

Conversation

marcosmarxm
Copy link
Member

What

Add new stream to Freshservice source

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
  • Documentation which references the generator is updated as needed
Updating the Python CDK

Airbyter

Before merging:

  • Pull Request description explains what problem it is solving
  • Code change is unit tested
  • Build and my-py check pass
  • Smoke test the change on at least one affected connector
    • On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
    • Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
  • PR is reviewed and approved

After merging:

  • Publish the CDK
    • The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
    • Write a thoughtful changelog message so we know what was updated.
  • Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
    • This step is optional if the change does not affect the connector builder or declarative connectors.

@marcosmarxm marcosmarxm requested a review from sajarin January 15, 2024 17:20
Copy link

vercel bot commented Jan 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Jan 16, 2024 1:22pm

Copy link

sweep-ai bot commented Jan 15, 2024

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

This is an automated message generated by Sweep AI.

@octavia-squidington-iii octavia-squidington-iii added connectors/source/freshservice area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Jan 15, 2024
Copy link
Contributor

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

Copy link

sweep-ai bot commented Jan 15, 2024

Sweeping

Fixing PR: track the progress here.

I'm currently fixing this PR to address the following:

[Sweep GHA Fix] The GitHub Actions run failed with the following error logs:

The command:
Run echo "::error::All checklist items not checked. Review your PR description and comments for unchecked items."
yielded the following error:
##[error]All checklist items not checked. Review your PR description and comments for unchecked items.
##[error]Process completed with exit code 1.
##[group]Run mheap/require-checklist-action@v2
with:
  requireChecklist: false
  token: ***
  skipComments: false
##[endgroup]
Incomplete task list item: **Apply:**  All new business logic should have corresponding unit tests.
Incomplete task list item: **Apply:**  Refactor large functions to be more modular.
Incomplete task list item: **Apply:**  Add docstrings to all functions and file headers.
##[error]The following items are not marked as completed: **Apply:**  All new business logic should have corresponding unit tests., **Apply:**  Refactor large functions to be more modular., **Apply:**  Add docstrings to all functions and file headers.

Here are the logs:


[!CAUTION]

An error has occurred: Cmd('git') failed due to: exit code(128)
cmdline: git clone -v --branch=marcos/freshservice-new-stream-requested-items -- https://:@github.com/airbytehq/airbyte.git /tmp/cache/repos/airbytehq/airbyte/base/marcos--freshservice-new-stream-requested-items
stderr: 'fatal: could not create work tree dir '/tmp/cache/repos/airbytehq/airbyte/base/marcos--freshservice-new-stream-requested-items': No space left on device
' (tracking ID: 144d95575c)

Copy link

sweep-ai bot commented Jan 15, 2024

Sweeping

Fixing PR: track the progress here.

I'm currently fixing this PR to address the following:

[Sweep GHA Fix] The GitHub Actions run failed with the following error logs:

The command:
Run echo "::error::All checklist items not checked. Review your PR description and comments for unchecked items."
yielded the following error:
##[error]All checklist items not checked. Review your PR description and comments for unchecked items.
##[error]Process completed with exit code 1.
##[group]Run mheap/require-checklist-action@v2
with:
  requireChecklist: false
  token: ***
  skipComments: false
##[endgroup]
Incomplete task list item: **Apply:**  All new business logic should have corresponding unit tests.
Incomplete task list item: **Apply:**  Refactor large functions to be more modular.
Incomplete task list item: **Apply:**  Add docstrings to all functions and file headers.
Incomplete task list item: PR name follows [PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention)
Incomplete task list item: [Breaking changes are considered](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#breaking-changes-to-connectors). If a **Breaking Change** is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
Incomplete task list item: Connector version has been incremented in the Dockerfile and metadata.yaml according to our [Semantic Versioning for Connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors) guidelines
Incomplete task list item: You've updated the connector's `metadata.yaml` file any other relevant changes, including a `breakingChanges` entry for major version bumps. See [metadata.yaml docs](https://docs.airbyte.com/connector-development/connector-metadata-file/)
Incomplete task list item: Secrets in the connector's spec are annotated with `airbyte_secret`
Incomplete task list item: All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
Incomplete task list item: Changelog updated in `docs/integrations/<source or destination>/<name>.md` with an entry for the new version. See changelog [example](https://docs.airbyte.io/integrations/sources/stripe#changelog)
Incomplete task list item: Migration guide updated in `docs/integrations/<source or destination>/<name>-migrations.md` with an entry for the new version, if the version is a breaking change. See migration guide [example](https://docs.airbyte.io/integrations/sources/faker-migrations)
Incomplete task list item: If set, you've ensured the icon is present in the `platform-internal` repo. ([Docs](https://docs.airbyte.com/connector-development/connector-metadata-file/#the-icon-field))
##[error]The following items are not marked as completed: **Apply:**  All new business logic should have corresponding unit tests., **Apply:**  Refactor large functions to be more modular., **Apply:**  Add docstrings to all functions and file headers., PR name follows [PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention), [Breaking changes are considered](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#breaking-changes-to-connectors). If a **Breaking Change** is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan., Connector version has been incremented in the Dockerfile and metadata.yaml according to our [Semantic Versioning for Connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors) guidelines, You've updated the connector's `metadata.yaml` file any other relevant changes, including a `breakingChanges` entry for major version bumps. See [metadata.yaml docs](https://docs.airbyte.com/connector-development/connector-metadata-file/), Secrets in the connector's spec are annotated with `airbyte_secret`, All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...), Changelog updated in `docs/integrations/<source or destination>/<name>.md` with an entry for the new version. See changelog [example](https://docs.airbyte.io/integrations/sources/stripe#changelog), Migration guide updated in `docs/integrations/<source or destination>/<name>-migrations.md` with an entry for the new version, if the version is a breaking change. See migration guide [example](https://docs.airbyte.io/integrations/sources/faker-migrations), If set, you've ensured the icon is present in the `platform-internal` repo. ([Docs](https://docs.airbyte.com/connector-development/connector-metadata-file/#the-icon-field))

Here are the logs:


[!CAUTION]

An error has occurred: Cmd('git') failed due to: exit code(128)
cmdline: git clone -v --branch=marcos/freshservice-new-stream-requested-items -- https://:@github.com/airbytehq/airbyte.git /tmp/cache/repos/airbytehq/airbyte/base/marcos--freshservice-new-stream-requested-items
stderr: 'fatal: could not create work tree dir '/tmp/cache/repos/airbytehq/airbyte/base/marcos--freshservice-new-stream-requested-items': No space left on device
' (tracking ID: 12f52ba77f)

Copy link

sweep-ai bot commented Jan 15, 2024

Sweeping

Fixing PR: track the progress here.

I'm currently fixing this PR to address the following:

[Sweep GHA Fix] The GitHub Actions run failed with the following error logs:

The command:
Run echo "::error::All checklist items not checked. Review your PR description and comments for unchecked items."
yielded the following error:
##[error]All checklist items not checked. Review your PR description and comments for unchecked items.
##[error]Process completed with exit code 1.
##[group]Run mheap/require-checklist-action@v2
with:
  requireChecklist: false
  token: ***
  skipComments: false
##[endgroup]
Incomplete task list item: **Apply:**  All new business logic should have corresponding unit tests.
Incomplete task list item: **Apply:**  Refactor large functions to be more modular.
Incomplete task list item: **Apply:**  Add docstrings to all functions and file headers.
Incomplete task list item: PR name follows [PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention)
Incomplete task list item: [Breaking changes are considered](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#breaking-changes-to-connectors). If a **Breaking Change** is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
Incomplete task list item: Connector version has been incremented in the Dockerfile and metadata.yaml according to our [Semantic Versioning for Connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors) guidelines
Incomplete task list item: You've updated the connector's `metadata.yaml` file any other relevant changes, including a `breakingChanges` entry for major version bumps. See [metadata.yaml docs](https://docs.airbyte.com/connector-development/connector-metadata-file/)
Incomplete task list item: Secrets in the connector's spec are annotated with `airbyte_secret`
Incomplete task list item: All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
Incomplete task list item: Changelog updated in `docs/integrations/<source or destination>/<name>.md` with an entry for the new version. See changelog [example](https://docs.airbyte.io/integrations/sources/stripe#changelog)
Incomplete task list item: Migration guide updated in `docs/integrations/<source or destination>/<name>-migrations.md` with an entry for the new version, if the version is a breaking change. See migration guide [example](https://docs.airbyte.io/integrations/sources/faker-migrations)
Incomplete task list item: If set, you've ensured the icon is present in the `platform-internal` repo. ([Docs](https://docs.airbyte.com/connector-development/connector-metadata-file/#the-icon-field))
##[error]The following items are not marked as completed: **Apply:**  All new business logic should have corresponding unit tests., **Apply:**  Refactor large functions to be more modular., **Apply:**  Add docstrings to all functions and file headers., PR name follows [PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention), [Breaking changes are considered](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#breaking-changes-to-connectors). If a **Breaking Change** is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan., Connector version has been incremented in the Dockerfile and metadata.yaml according to our [Semantic Versioning for Connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors) guidelines, You've updated the connector's `metadata.yaml` file any other relevant changes, including a `breakingChanges` entry for major version bumps. See [metadata.yaml docs](https://docs.airbyte.com/connector-development/connector-metadata-file/), Secrets in the connector's spec are annotated with `airbyte_secret`, All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...), Changelog updated in `docs/integrations/<source or destination>/<name>.md` with an entry for the new version. See changelog [example](https://docs.airbyte.io/integrations/sources/stripe#changelog), Migration guide updated in `docs/integrations/<source or destination>/<name>-migrations.md` with an entry for the new version, if the version is a breaking change. See migration guide [example](https://docs.airbyte.io/integrations/sources/faker-migrations), If set, you've ensured the icon is present in the `platform-internal` repo. ([Docs](https://docs.airbyte.com/connector-development/connector-metadata-file/#the-icon-field))

Here are the logs:


[!CAUTION]

An error has occurred: Cmd('git') failed due to: exit code(128)
cmdline: git clone -v --branch=marcos/freshservice-new-stream-requested-items -- https://:@github.com/airbytehq/airbyte.git /tmp/cache/repos/airbytehq/airbyte/base/marcos--freshservice-new-stream-requested-items
stderr: 'fatal: could not create work tree dir '/tmp/cache/repos/airbytehq/airbyte/base/marcos--freshservice-new-stream-requested-items': No space left on device
' (tracking ID: 30180c6910)

@marcosmarxm marcosmarxm merged commit dc8df8f into master Jan 16, 2024
23 of 24 checks passed
@marcosmarxm marcosmarxm deleted the marcos/freshservice-new-stream-requested-items branch January 16, 2024 13:45
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/freshservice
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants