libgit2 / libgit2/libgit2sharp
libgit2sharp is agnostic of GitHub Personal Access Token related errors
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 925
- PR merge metrics
- No merged PRs in 30d
Description
Introduction
It's been a while since github deprecated the use of password on CLIs and applications. Personal access token is the way to get authenticated on these apps. libgit2sharp is quiet on errors and warnings pertinent to PATs.
For example,
access tokens can be created with only repository access. Which is restricted to do modifications outside the repository i.e., workflows, wikis and projects. Hence, trying to modify a workflow file using this token should outcome an access exception.
However, libgit2sharp behaves as if nothing happened when that event does occur. Nothing is performed, push fails, however, there is no error/warning report from libgit2sharp.
Reproduction steps
Create a PAT with only repository access. Now try to push a commit that modifies a workflow file.
Expected behavior
Show throw an exception or report an error.
Actual behavior
Does not throw an exception, behaves as if push was successful. However, push actually failed.
to mimic the behavior of git, behavior of libgit2sharp should look like following,
I created an example commit that modified following github workflow file: D:\Code\MyBlog\.github\workflows\deploy.yml
git properly reports the error,
$ git push origin dev
Enumerating objects: 17, done.
Counting objects: 100% (17/17), done.
Delta compression using up to 16 threads
Compressing objects: 100% (6/6), done.
Writing objects: 100% (9/9), 804 bytes | 268.00 KiB/s, done.
Total 9 (delta 4), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
To https://github.com/matrix/blog.git
! [remote rejected] dev -> dev (refusing to allow a Personal Access Token to create or update workflow `.github/workflows/deploy.yml` without `workflow` scope)
error: failed to push some refs to 'https://github.com/matrix/blog.git'
Version of LibGit2Sharp (release number or SHA1)
Latest
Operating system(s) tested; .NET runtime tested
Win 10, net sdk: 6.0.101
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the push against a repository using a PAT without workflow scope, modifying .github/workflows/deploy.yml, and compare the result with the Git command shown in the issue. Trace the push operation and its reported errors in the libgit2sharp source; done means a rejected workflow push raises an exception or reports the remote error instead of appearing successful.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, git
- Domain
- authentication, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100