Hi Airbyte team! Do I need to submit a documentati...
# contributing-to-airbyte
m
Hi Airbyte team! Do I need to submit a documentation for the source I'm developing similar to https://docs.airbyte.io/integrations/sources/braintree ? If yes, how/where do I do it?
u
In the github repository, that page is here: https://github.com/airbytehq/airbyte/blob/master/docs/integrations/sources/braintree.md so you are welcome to add your own doc there too
u
Awesome! Thank you @Chris (deprecated profile)!
u
I'm finishing up this connector: https://github.com/airbytehq/airbyte/issues/1489 Do I need to create an issue for you guys to create your own credentials for Appstore API and add it to Github secrets? Or should I skip that?
u
you can create the issue, that would help! thanks
u
Ok!! I'll do both 🙂
u
Done, I was not sure if I used the correct issue tags, but I put it under 'new integration' https://github.com/airbytehq/airbyte/issues/1631
u
Thanks! We will have someone try to get those creds today. you don't have to wait to put up a PR for us to do this. 😄
u
Great! Thanks @charles 🙂
u
Do I do the PR with this instructions, or do I ingore them for now? 1. Once the config is stored in Github Secrets, edit 
.github/workflows/gradle.yaml
 to inject the config into the build environment. 2. Edit the 
airbyte/tools/bin/ci_credentials.sh
 script to pull the script from the build environment and write it to 
secrets/config.json
 during the build.\\
u
you can ignore them. we will handle it once we get the credentials.
u
Ok 🙂
u
thanks for mentioning it. i think i will remove those from the checklist so it's not confusing for people in the future.
u
Pull request sent. Any issues please let me know and I'll try to fix it.
u
Thank you @Murilo Nigris airbyte heart
u
Just reviewed it. I have only one question that I want to figure out and then we will merge.
u
Happy to follow up on github or in this thread. 🎉
u
@charles, we can talk here
u
Please, go ahead
u
u
Should I change here and do another PR?
u
1. Quick question about github 😅, should I commit the changes you suggested on the other files via the github UI button and then I rebase my own repo, or is there a better way?
u
2. About your comment of checking the status_code, as the singer tap is using this library, it either returns a 'tsv' format string or will return an API error as string. In the tap code the only way we thought about coding it was:
Copy code
try:
                rep_tsv = api.download_sales_and_trends_reports(filters=
                    report_filters)
            except APIError as e:
                LOGGER.error(e)
                break
            
            # parse api response
            if isinstance(rep_tsv, dict):
                LOGGER.warning("Received a JSON response instead of the report: %s", str(rep_tsv))
                break
            else:
                rep = tsv_to_list(rep_tsv)
u
On a second thought, I'm not sure it's ideal to change this, the alternative would be bypass the use of this library, but then it generates other problems such as incompatibility with the rest of the code. Makes sense?
u
3. Before you approve the PR, I just tried to run the 'docker-compose up' but I'm not seeing any sources available in the UI anymore:
u
(sorry the amount of comments)
u
Quick question about github 😅, should I commit the changes you suggested on the other files via the github UI button and then I rebase my own repo, or is there a better way?
i would just hit commit in the ui and then git pull
u
that should pull down the changes.
u
if you have already made changes on your local branch then yeah you'll need to rebate.
u
On a second thought, I'm not sure it's ideal to change this, the alternative would be bypass the use of this library, but then it generates other problems such as incompatibility with the rest of the code. Makes sense?
got it! i see that makes sense we can leave it as is.
u
Before you approve the PR, I just tried to run the 'docker-compose up' but I'm not seeing any sources available in the UI anymore:
weird. can you run
docker-compose down
u
then run
docker volume rm $(docker volume ls -q | grep airbyte)
u
this will clear out the volumes
u
and then
docker-compose up
u
let me know if that helps!
u
It solved the error, but the Integration is not appearing yet 😞
u
DId you test in your machine the PR? Did it work for you?
u
oh! I see. so until we merge it, it can only be accessed in "dev mode"
u
you can see the instructions for how to run airbyte in dev mode in our docs here: https://docs.airbyte.io/contributing-to-airbyte/developing-locally#run-in-dev-mode-with-docker-compose
u
lmk if any how to get that running is unclear.
u
I'll try it 🙂
u
Is still missing anything from my part regarding the PR? Or now it's with you guys?
u
Charles, the cmd in the URL above returns only this:
Copy code
./gradlew build
docker-compose --env-file .env.dev -f docker-compose.yaml -f docker-compose.dev.yaml up
u
weird!
u
i just merged your PR. appstore will be visible once i bump the airbyte version. will ping you when that's done.
u
Awesome!! Thank you 😄
u
it'll probably take me about an hour.
u
Ok, I'm starting to work on the appsflyer one: https://github.com/airbytehq/airbyte/issues/1649
u
I hope this is ok
u
yeah! that's great. are you going to try to do it without singer?
u
would be curious if you found that easier.
u
Not really, I'm under a tight deadline. The next after that I can try 🙂
u
ok
u
no problem.
u
Which I hope I also start today hehe
u
remind me what destination you're using again?
u
BigQuery
u
Why?
u
just curious. i'm interested to know which sources and destinations people are using.
u
you should be able to see your source in the app now on master.
u
Hi @charles! I'm not seeing the appstore connector. I was checking the commits and saw that the CI run failed due to the lack of docker image: https://github.com/airbytehq/airbyte/runs/1703212511
u
weird. i'll take a look this afternoon.
u
Thankss!!
u
I see it in the dropdown.
u
can you turn off airbyte
docker-compose down -v
. git pull (to get newest version of airbyte) and then
docker-compose up -V