Merge pull request #1132 from anz-ableton/fix-1121/github-api-version-header

Allow to set GitHub API version

Author: sigmavirus24

src/github3/github.py

@@ -59,9 +59,21 @@ class GitHub(models.GitHubCore):
     call the GitHub object with authentication parameters.
     """
 
-    def __init__(self, username="", password="", token="", session=None):
-        """Create a new GitHub instance to talk to the API."""
+    def __init__(
+        self, username="", password="", token="", session=None, api_version=""
+    ):
+        """Create a new GitHub instance to talk to the API.
+
+        :param str api_version:
+            API version to send with X-GitHub-Api-Version header.
+            See https://docs.github.com/en/rest/overview/api-versions
+            for details about API versions.
+        """
         super().__init__({}, session or self.new_session())
+
+        if api_version:
+            self.session.headers.update({"X-GitHub-Api-Version": api_version})
+
         if token:
             self.login(username, token=token)
         elif username and password:

tests/unit/test_github.py

@@ -1390,6 +1390,14 @@ def test_search_users(self):
             headers={},
         )
 
+    def test_api_version_header(_):
+        gh = GitHub(api_version="2022-11-28")
+        assert gh.session.headers.get("X-GitHub-Api-Version") == "2022-11-28"
+
+    def test_api_version_header_not_defined(_):
+        gh = GitHub()
+        assert gh.session.headers.get("X-GitHub-Api-Version") is None
+
 
 class TestGitHubRequiresAuthentication(
     helper.UnitRequiresAuthenticationHelper