How To Manage A GitHub Repository Using API
Hello Everyone
Welcome to CloudAffaire and this is Debjeet.
GitHub provides full set of API endpoints to manage all your GitHub repository using API. In this blog post, we will discuss how to manage a GitHub repository using API.
As more and more projects adopting Cloud and DevOps and entire stack from application to infrastructure is managed through CI/CD pipeline, it’s the need to the hour to able to manage everything programmatically and GitHub is no exception.
How To Manage A GitHub Repository Using API
Prerequisites:
How To Create A New GitHub Repository Using API
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
## I am using Linux Shell for this demo ## Replace github_personal_access_token ## github_repository_name, github_user_name ## and github_branch_name ## Create a new GitHub repository curl -i -H "Authorization: token <github_personal_access_token>" \ -d '{ "name": "<github_repository_name>", "description": "GitHub repo created through API", "homepage": "http://<github_user_name>.com/", "auto_init": true, "private": true, "gitignore_template": "nanoc" }' \ https://api.github.com/user/repos ## Get a GitHub repository details in your account curl \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name> ## List all GitHub repositories in your account curl \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/users/<github_user_name>/repos |
How To Update An Existing GitHub Repository Using API
|
1 2 3 4 5 6 |
## Update a GitHub repository using API curl \ -X PATCH \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name> \ -d '{"private":"false"}' |
Note: Here we have changed the repository from private to public.
How To Upload A File In GitHub Repository Using API
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
## Create a new file in GitHub echo 'hello world' | base64 # returns aGVsbG8gd29ybGQK curl \ -X PUT \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/contents/mydir1/myfile1.txt \ -d '{"message":"file myfile1.txt added","content":"aGVsbG8gd29ybGQK"}' ## Get all commits in GitHub using API curl \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/commits |
How To Create A New Branch In GitHub Using API
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
## Create a new branch in GitHub curl -H "Authorization: token <github_personal_access_token>" \ -d '{ "ref": "refs/heads/<github_branch_name>", "sha": "44e5949f55599f486fe92e1677b6c95b019e0335" }' \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/git/refs ## You can get the commit sha like below ## curl \ ## -H "Authorization: token <github_personal_access_token>" \ ## https://api.github.com/repos/<github_user_name>/<github_repository_name>/commits | jq -r .[1].sha ## List all branches in GitHub curl -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/branches ## Create a new file in GitHub branch echo 'welcome to <github_user_name>' | base64 # returns d2VsY29tZSB0byBjbG91ZGFmZmFpcmUK curl \ -X PUT \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/contents/mydir2/myfile2.txt \ -d '{"message":"file myfile2.txt added","content":"d2VsY29tZSB0byBjbG91ZGFmZmFpcmUK","branch":"<github_branch_name>"}' |
How To Merge Branches In GitHub Using API
|
1 2 3 4 5 6 |
## Merge two branches in GitHub curl \ -X POST \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/merges \ -d '{"base":"main","head":"<github_branch_name>"}' |
How To Delete A Branch In GitHub Using API
|
1 2 3 4 5 |
## Delete the feature branch in GitHub using API curl \ -X DELETE \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name>/git/refs/heads/<github_branch_name> |
How To Delete A Repository In GitHub Using API
|
1 2 3 4 5 |
## Delete the GitHub repository curl \ -X DELETE \ -H "Authorization: token <github_personal_access_token>" \ https://api.github.com/repos/<github_user_name>/<github_repository_name> |
Hope you have enjoyed this article. To know more about GitHub, please refer below official documentation