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 Clockify: Add Optional API Url parameter #28622

Merged
merged 3 commits into from
Aug 1, 2023

Conversation

sajarin
Copy link
Contributor

@sajarin sajarin commented Jul 24, 2023

What

Running ci tests for #27689
Currently the source-clockify connector does not support subdomains for enterprise instances of clockify (e.g. mycompany.clockify.me)

#Describe what the change is solving
It helps to add screenshots if it affects the frontend.
Add an optional parameter of api_url to source-clockify
See #27688 for more details
Screenshot 2023-06-24 at 7 00 19 PM

How

Describe the solution
This solution adds an optional parameter of api_url with a default value of https://api.clockify.me and allows it to be customized.

Recommended reading order

  1. source_clockify/spec.json
  2. source_clockify/streams.py
  3. source_clockify/source.py

🚨 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.
This PR contains no breaking changes. The version is minor since it adds an optional parameter of api url to the connector as per https://docs.airbyte.com/contributing-to-airbyte/#examples.

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:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

@octavia-squidington-iii octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Jul 24, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 24, 2023

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.

@octavia-squidington-iii
Copy link
Collaborator

source-clockify test report (commit c60a25085e) - ❌

⏲️ Total pipeline duration: 02mn36s

Step Result
Validate airbyte-integrations/connectors/source-clockify/metadata.yaml
Connector version semver check
Connector version increment check
QA checks
Code format checks
Connector package install
Build source-clockify docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-clockify test

@octavia-squidington-iii
Copy link
Collaborator

source-clockify test report (commit 5fd506a76e) - ❌

⏲️ Total pipeline duration: 03mn41s

Step Result
Validate airbyte-integrations/connectors/source-clockify/metadata.yaml
Connector version semver check
QA checks
Code format checks
Connector package install
Build source-clockify docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-clockify test

@sajarin sajarin force-pushed the saj/clockify-api-url branch from 5fd506a to d7c80ce Compare August 1, 2023 17:41
@octavia-squidington-iii
Copy link
Collaborator

source-clockify test report (commit d7c80ce756) - ✅

⏲️ Total pipeline duration: 05mn41s

Step Result
Validate airbyte-integrations/connectors/source-clockify/metadata.yaml
Connector version semver check
Connector version increment check
QA checks
Code format checks
Connector package install
Build source-clockify docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-clockify test

@octavia-squidington-iii
Copy link
Collaborator

source-clockify test report (commit 3af5b24237) - ✅

⏲️ Total pipeline duration: 03mn07s

Step Result
Validate airbyte-integrations/connectors/source-clockify/metadata.yaml
Connector version semver check
QA checks
Code format checks
Connector package install
Build source-clockify docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-clockify test

Copy link
Contributor

@archangelic archangelic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sajarin sajarin merged commit 2d1e0fa into master Aug 1, 2023
@sajarin sajarin deleted the saj/clockify-api-url branch August 1, 2023 18:06
bnchrch pushed a commit that referenced this pull request Aug 3, 2023
* Add api_url as optional parameter to source-clockify

See #27688 for more details

* fix: update clients schema and migrate acceptance-test-config.yml from legacy

---------

Co-authored-by: Ezra Quemuel <ezra.quemuel@redesignhealth.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

5 participants