Skip to content

Getting Started

_Coho04_ edited this page Jun 19, 2024 · 1 revision

To get started with GithubAPI, follow these steps to interact with GitHub repositories:

  1. Initialize GithubAPI:
Github github = new Github("your_access_token");
  1. Get Repository by Organisation:
GHOrganisation organisation = github.findOrganisationByName("organisation_name");
GHRepository repository = organisation.findRepositoryByName("repo_name");
System.out.println("Repository name: " + repository.getName());
  1. Get Repository by User:
GHUser user = github.findUserByName("username");
GHRepository userRepository = user.findRepositoryByName("repo_name");
System.out.println("Repository name: " + userRepository.getName());
  1. Get Repositories by SelfUser:
GHUser selfUser = github.getSelfUser();
GHRepository selfUserRepository = selfUser.findRepositoryByName("repo_name");
System.out.println("Repository name: " + selfUserRepository.getName());

These examples demonstrate how to authenticate, and retrieve repositories by organization, user, and the authenticated user. Make sure to replace "your_access_token", "organisation_name", "username", and "repo_name" with actual values.

Clone this wiki locally