Merge branch 'dev'

Author: Xgames123

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "git-credential-github"
 authors = ["ldev <ldev at ldev dot eu dot org>"]
-version = "2.0.0"
+version = "2.1.0"
 license-file="LICENSE.md"
 edition = "2021"
 description="A simple git credentials helper for github"
@@ -10,10 +10,11 @@ description="A simple git credentials helper for github"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-clap = {version = "4.3", features = ["default", "cargo", "derive"]}
+clap = {version = "4.4", features = ["default", "cargo", "derive"]}
 reqwest = {version = "0.11", features= ["json"]}
 serde = {version="1.0", features=["derive"]}
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
-shlex = {version= "1.1.0"}
+shlex = {version= "1.2.0"}
 log = {version="0.4"}
+thiserror={version="1.0.50"}
 stderrlog = {version="0.5"}

README.md

@@ -31,7 +31,7 @@ This sets the credential helper for github using the cache helper with a timeout
 ### Set only for repos owned by you
 ```~/.gitconfig```
 ```ini
-[credentials]
+[credential]
 	useHttpPath = true
 [credential "https://github.com/Xgames123"] # change to your name
   username=Xgames123 # change to your name
@@ -52,3 +52,8 @@ If you find a bug, get an error or the docs are wrong.
 * [Create an issue](https://github.com/Xgames123/git-credential-github/issues/new/)
 * Message me <[[email protected]](mailto://[email protected])>
 * Message me on discord [ldev105](https://ldev.eu.org/socials/discord)
+
+
+# Building debian packages from source
+1. install [reltools](https://github.com/Xgames123/reltools)
+2. run makepkg_deb inside the packaging directory

TODO_RELEASE.md

@@ -0,0 +1,8 @@
+1. bump versions: Cargo.toml, packaging/PKGBUILD
+4. merge with main
+5. tag commit and create release
+
+6. bump aur/PKGBUILD
+7. makepkg_deb.sh
+8. regen checksums (aur/PKGBUILD) and .SRCINFO
+9. close issues fixed in release

packaging/PKGBUILD

@@ -1,4 +1,4 @@
-pkgver=2.0.0
+pkgver=2.1.0
 pkgrel=1
 
 pkgname=git-credential-github

packaging/makepkg_deb.sh

@@ -1,8 +1,9 @@
 use std::collections::HashMap;
 use std::io;
 use std::process::{Child, Command, Stdio};
+use thiserror::Error;
 
-use log::debug;
+use log::{debug, error};
 
 use crate::{paramparsing, Operation};
 
@@ -27,11 +28,19 @@ fn spawn_helper(helper: &str, operation: Operation) -> io::Result<Child> {
     Ok(cmd.spawn()?)
 }
 
+#[derive(Error, Debug)]
+pub enum CredHelperError {
+    #[error("{0}")]
+    Io(#[from] std::io::Error),
+    #[error("credential helper exited with code {0}")]
+    Non0ExitCode(i32, Option<HashMap<String, String>>),
+}
+
 pub fn run(
     helper: &str,
     operation: Operation,
     params: &HashMap<String, String>,
-) -> io::Result<HashMap<String, String>> {
+) -> Result<HashMap<String, String>, CredHelperError> {
     let mut process = spawn_helper(helper, operation)?;
     let mut stdin = process.stdin.take().unwrap();
     paramparsing::write_to(&params, &mut stdin)?;
@@ -40,6 +49,14 @@ pub fn run(
     let mut stdout = process.stdout.take().unwrap();
     let output_params = paramparsing::parse_from(&mut stdout)?;
     drop(stdout);
-    process.wait()?;
-    Ok(output_params)
+    let output = process.wait()?;
+
+    if !output.success() {
+        Err(CredHelperError::Non0ExitCode(
+            output.code().unwrap_or_default(),
+            Some(output_params),
+        ))
+    } else {
+        Ok(output_params)
+    }
 }

src/credhelper.rs

@@ -40,6 +40,14 @@ struct Cli {
     #[arg(long)]
     no_clip: bool,
 
+    /// Go through the authentication process even if not needed. (only for get operation)
+    #[arg(long)]
+    auth: bool,
+
+    /// Don't authenticate when the credential helper returns a non 0 exit code
+    #[arg(long)]
+    no_auth_on_fail: bool,
+
     #[command(subcommand)]
     operation: Operation,
 }
@@ -100,16 +108,29 @@ async fn main() {
     }
 
     let mut output =
-        credhelper::run(&backing_helper, cli.operation, &params).unwrap_or_else(|err| {
-            die!(
-                "Failed to run credential helper '{}'\n{}",
-                backing_helper,
-                err
-            );
+        credhelper::run(&backing_helper, cli.operation, &params).unwrap_or_else(|err| match err {
+            credhelper::CredHelperError::Io(err) => {
+                die!(
+                    "Failed to run credential helper '{}'\n{}",
+                    backing_helper,
+                    err
+                );
+            }
+            credhelper::CredHelperError::Non0ExitCode(code, output) => {
+                error!(
+                    "Credential helper '{}' exited with code: {}",
+                    backing_helper, code
+                );
+                if cli.no_auth_on_fail {
+                    die!("See Last error");
+                }
+
+                output.unwrap_or_default()
+            }
         });
 
-    if cli.operation.is_get() && !output.contains_key("password") {
-        debug!("No password returned by helper. Fetching credentials..");
+    if cli.operation.is_get() && (!output.contains_key("password") || cli.auth) {
+        debug!("Fetching credentials..");
         let client = Client::new();
         let device_code = ghauth::get_device_code(&client).await.unwrap();
 

src/main.rs

@@ -0,0 +1,20 @@
+# script to verify versions
+
+cargo_ver=$(rg -or "\$1" "^version[\t ]*=[\t ]*\"([0-9]\.[0-9]\.[0-9])\"" Cargo.toml)
+echo "version: $cargo_ver"
+pkg_ver=$(rg -or "\$1" "^pkgver=[\t ]*([0-9]\.[0-9]\.[0-9])" packaging/PKGBUILD)
+
+git_ver=$(git tag | tail -n 1)
+
+
+if [ "$cargo_ver" != "$pkg_ver" ] ; then
+  echo "PKGBUILD version '$pkg_ver' doesn't match $cargo_ver"
+  exit -1
+fi
+
+if [ "$git_ver" != "$cargo_ver" ] ; then
+  echo "git tag '$git_ver' doesn't match version $cargo_ver"
+  exit -1
+fi
+
+echo "ALL CHECKS OK"