Source GitHub: Add option to pull commits from user-specified branches

[cjwooo]

What

Currently, the GitHub source only pulls commits from each repository's default branch. We want to pull commits from multiple branches.

How

Add an option to specify a space-delimited list of repository branches to pull commits for. If no branches are specified for a repository, the source will pull only the default branch as it does currently. Cursor field state is tracked per branch instead of per repository.

Recommended reading order

1. x.java
2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

• Community member? Grant edit access to maintainers (instructions)
• Secrets in the connector's spec are annotated with airbyte_secret
• 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.
• Code reviews completed
• Documentation updated
  • Connector's README.md
  • Connector's bootstrap.md. See description and examples
  • docs/SUMMARY.md
  • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • docs/integrations/README.md
  • airbyte-integrations/builds.md
• PR name follows PR naming conventions
• Connector added to connector index like described here

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
• Credentials added to Github CI. Instructions.
• /test connector=connectors/<name> command is passing.
• New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

• Grant edit access to maintainers (instructions)
• Secrets in the connector's spec are annotated with airbyte_secret
• 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.
• Code reviews completed
• Documentation updated
  • Connector's README.md
  • Connector's bootstrap.md. See description and examples
  • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
• PR name follows PR naming conventions
• Connector version bumped like described here

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
• Credentials added to Github CI. Instructions.
• /test connector=connectors/<name> command is passing.
• New Connector version released on Dockerhub by running the /publish command described here

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.

[cjwooo]

I just realized this might break on reading existing Github state of previous versions. Any suggestions on how to resolve this?

[yevhenii-ldv]

Please see comments

[yevhenii-ldv]

@cjwooo Regarding this question.
I think that we can check which state the user is currently using, and in the output, in any case, we will receive a new state.
Something like this (Very draft version):

    def get_updated_state(self, current_stream_state: MutableMapping[str, Any], latest_record: Mapping[str, Any]):
        state_value = latest_cursor_value = latest_record.get(self.cursor_field)
        current_repository = latest_record["repository"]
        current_branch = latest_record["branch"]

        if current_stream_state.get(current_repository):
            repository_commits_state = current_stream_state[current_repository]
            if repository_commits_state.get(self.cursor_field):
                if  current_branch == repository["default_branch"]: # It is necessary to somehow throw `repository["default_branch"]` parameter here. 
                    state_value = max(latest_cursor_value, repository_commits_state [self.cursor_field])
                else:
                    state_value = latest_cursor_value
            elif repository_commits_state.get(current_branch, {}).get(self.cursor_field):
                state_value = max(latest_cursor_value, repository_commits_state[current_branch][self.cursor_field])
        if current_repository not in current_stream_state:
            current_stream_state[current_repository] = {}
        current_stream_state[current_repository][current_branch] = {self.cursor_field: state_value}
        return current_stream_state

[cjwooo]

@yevhenii-ldv This PR is ready for review again.

[yevhenii-ldv]

Hey @cjwooo!
I looked at the code, LGTM, tomorrow (for my timezone), I will create a copy of this PR-and inside the Airbyte project (not in the fork branch) and run tests to make sure everything is fine. If everything works fine, tomorrow I will release a new version of the connector with your changes.

Thank you!

[marcosmarxm]

thanks a lot both! 🎉

[yevhenii-ldv]

Merged as #6223