Mark v3.0.1 patch

Barely anything has changed, but the package *is* different. v3 is from
months back and is missing information that Crates.io kinda wants.

.gitea/workflows/release.yml

@@ -22,7 +22,9 @@ jobs:
       - name: Upload the program (using itself!)
         run: >
           target/release/gt-tool-${{ github.ref_name }}-$(arch)
-          -u ${{ vars.DEST_GITEA }} -r ${{ vars.DEST_REPO }}
+          -u ${{ vars.DEST_GITEA }}
+          -o ${{ vars.DEST_OWNER }}
+          -r ${{ vars.DEST_REPO }}
           upload-release
           "${{ github.ref_name }}"
           target/release/gt-tool-${{ github.ref_name }}-$(arch)

Cargo.toml

@@ -1,23 +1,18 @@
 [package]
 name = "gt-tool"
-version = "2.2.0"
+version = "3.0.1"
 edition = "2024"
+license = "GPL-3.0-only"
+description = "CLI tools for interacting with the Gitea API. Mainly for attaching files to releases."
+# homepage = "" I have no website for a project home page :(
+repository = "https://git.gelvin.dev/robert/gt-tool"
+readme = "README.md"
 
 [dependencies]
-clap = { version = "4.0.7", features = ["derive", "env"] }
+clap = { version = "4.5.23", features = ["derive", "env"] }
-colored = "2.0.0"
+colored = "2.2.0"
-itertools = "0.10.0"
+itertools = "0.13.0"
-reqwest = { version = "0.11.13", features = ["json", "stream", "multipart"] }
+reqwest = { version = "0.12.15", features = ["json", "stream", "multipart"] }
-serde = { version = "1.0.152", features = ["derive"] }
+serde = { version = "1.0.217", features = ["derive"] }
-tokio = { version = "1.24.2", features = ["macros", "rt-multi-thread"] }
+tokio = { version = "1.43.1", features = ["macros", "rt-multi-thread"] }
-toml = "0.5"
+toml = "0.8.19"
-
-# Packages available in Debian (Sid)
-# clap = "4.5.23"
-# reqwest = "0.12.15"
-# tokio = "1.43.1"
-
-# Debian (Bookworm)
-# clap = "4.0.32"
-# reqwest = "0.11.13"
-# tokio = "1.24.2"

README.md

@@ -5,7 +5,7 @@ CLI tools for interacting with the Gitea API. Use interactively to talk to your
 ## Usage
 
 ```txt
-Usage: gt-tools --url <GITEA_URL> --repo <REPO> <COMMAND>
+Usage: gt-tool [OPTIONS] <COMMAND>
 
 Commands:
   list-releases   
@@ -14,35 +14,52 @@ Commands:
   help            Print this message or the help of the given subcommand(s)
 
 Options:
-  -u, --url <GITEA_URL>  [env: GTTOOL_GITEA_URL=]
+  -u, --url <GITEA_URL>    [env: GTTOOL_GITEA_URL=]
-  -r, --repo <REPO>      [env: GTTOOL_FQRN=]
+  -o, --owner <OWNER>      [env: GTTOOL_OWNER=]
-  -h, --help             Print help
+  -r, --repo <REPO>        [env: GTTOOL_REPO=]
-  -V, --version          Print version
+  -p, --project <PROJECT>  Path to project (relative or absolute). Used to override configuration selection.
+  -h, --help               Print help
+  -V, --version            Print version
 ```
 
+### Required Information
+
+To function, this program requires knowledge of these items:
+
+- Gitea URL
+- Owner of repository
+- Repository name
+
+This info will be gathered from these locations, in order of priority:
+
+1. CLI argument
+2. Environment variable
+3. Configuration files
+
+It's worth noting that the "owner" is the entity that controls the repo on the Gitea instance. This will be the first part of the route in the URL: `http://demo.gitea.com/{owner}`.
+
+Likewise, the "repo" is what ever the Gitea instance thinks it's called -- which doesn't have to match anyone's local copy! It will be the second part of the route in the URL: `http://demo.gitea.com/{owner}/{repo}`.
+
 ### Authentication
 
-Authentication is token-based via environment variable `RELEASE_KEY_GITEA`.
+Authentication is token-based. There is no CLI option to prevent the token from appearing in any command logs.
 
-Ensure your token has the appropriate access for your usage. This depends on what you're doing and how your Gitea instance is configured, so you'll have to figure it out for yourself.
+In order of priority, the token is loaded from:
 
-Most likely, you will need a token with "repository: read-and-write" permissions. See Gitea's documentation on [token scopes](https://docs.gitea.com/development/oauth2-provider#scopes) for more.
+1. The environment variable `RELEASE_KEY_GITEA`
+2. Config files, key `token`
 
-### `<GITEA_URL>`:
+Whether or not it is required depends on how your Gitea instance and the repositories inside are configured.  For example, a default Gitea configuration will allow unauthenticated users to see public repositories but not make any changes. This means no token is required to run `gt-tool list-releases`, while `gt-tool upload-release` *will* require a token.
 
-The Gitea server URL must be provided with `--url` or `-u` on the command line, or via the environment variable `GTTOOL_GITEA_URL`. Use the base URL for your Gitea instance.
+For details, see Gitea's documentation on [token scopes](https://docs.gitea.com/development/oauth2-provider#scopes).
 
-E.g.: Using the Gitea org's demo instance, it would be: `--url "https://demo.gitea.com/"`
+### The `--project` option
 
-### `<REPO>`:
+Settings retrieved from config files are selected based on the project's path. By default, the current directory will be used. In case that guess is incorrect, this option can be specified with another path.
 
-The repository name must be provided with `--repo` or `-u` on the command line, or via the environment variable `GTTOOL_GITEA_FQRN` ("fully qualified repo name"). Use the format `<owner>/<repo>`, which is the route immediately following the GITEA_URL base. This is how GitHub and Gitea identify repos in the URL, and how Golang locates it's modules, so this tool does the same.
+See [configuration](#configuration) for details on format and file locations.
 
-E.g.: `--repo "go-gitea/gitea"` would name the Gitea repo belonging to the go-gitea organization.
+### Commands:
-
-### `<COMMAND>`:
-
-One of these, defaults to `help`:
 
 | Command | Description |
 |-|-|
@@ -51,3 +68,61 @@ One of these, defaults to `help`:
 | upload-release | Uploads one-or-more files to an existing release, identified by it's tag name. |
 | help | prints the help text (the usage summary above). |
 
+## Configuration
+
+Instead of specifying everything on the command line every single run, some TOML files can be used to persist project settings.
+
+> Exporting some environment variables would be similar, but that would be *more* annoying when working on multiple projects. One would have to constantly re-export the settings or use two shells. But then there's the issue of losing track of which shell has which settings.
+
+### File Format
+
+Settings are retrieved from a table named the same as the project's path on disk. For example, gt_tool itself could have an entry as follows:
+
+```toml
+["/home/robert/projects/gt-tool"]
+gitea_url = "https://demo.gitea.com/"
+owner = "dummy"
+repo = "gt-tool"
+token = "fake-token"
+```
+
+Sometimes one may want to apply a setting to all projects. For this, they can use the special `[all]` table.
+
+```toml
+[all]
+gitea_url = "https://demo.gitea.com/"
+```
+
+Since the more-specific settings are preferred, these can be combined to have an override effect.
+
+```toml
+[all]
+gitea_url = "https://demo.gitea.com/"
+owner = "robert"
+token = "fake-token"
+
+# Override Gitea target so I can test my uploads privately.
+["/home/robert/projects/gt-tool"]
+gitea_url = "http://localhost:3000"
+repo = "gt-tool"
+```
+
+### Search Paths
+
+Similar to how unspecified project settings will fall back to those in the "`[all]`" table, whole files will fall back to other, lower priority files.
+
+1. First, each dir in `$XDG_CONFIG_DIRS` is scanned for a `gt-tool.toml` file.
+2. Then, `/etc/gt-tool.toml`.
+
+> All config files **MUST** be named named `gt-tool.toml`.
+
+### Recognized Keys
+
+| Key | Description |
+|-|-|
+| gitea_url |  URL of the Gitea server. Same as `-u`, `--url`, and `$GTTOOL_GITEA_URL`. |
+| owner | Owner of the repository (individual, or organization). Combined with "repo" key to produce the fully-qualified-repo-name. Front-half of `-r`, `--repo`, and `$GTTOOL_FQRN` |
+| repo | Name of the repository on the Gitea server. Combined with "owner" key to produce the fully-qualified-repo-name. Back-half of `-r`, `--repo`, and `$GTTOOL_FQRN` |
+| token | Gitea auth token, exactly the same as `$RELEASE_KEY_GITEA` |
+
+Additional keys are quietly ignored. The config loading is done by querying a HashMap, so anything not touched doesn't get inspected. The only requirements are that the file is valid TOML, and that these keys are all strings.h

src/cli.rs

@@ -5,8 +5,16 @@ use clap::{Parser, Subcommand};
 pub struct Args {
     #[arg(short = 'u', long = "url", env = "GTTOOL_GITEA_URL")]
     pub gitea_url: Option<String>,
-    #[arg(short = 'r', long = "repo", env = "GTTOOL_FQRN")]
+    #[arg(short = 'o', long = "owner", env = "GTTOOL_OWNER")]
+    pub owner: Option<String>,
+    #[arg(short = 'r', long = "repo", env = "GTTOOL_REPO")]
     pub repo: Option<String>,
+    #[arg(
+        short = 'p',
+        long = "project",
+        help = "Path to project (relative or absolute). Used to override configuration selection."
+    )]
+    pub project: Option<String>,
 
     #[command(subcommand)]
     pub command: Commands,

src/config.rs

@@ -110,15 +110,15 @@ pub fn get_config(
                 // 3b. or default, if the table couldn't be found.
                 .or(Ok(PartialConfig::default()))
                 // 4. assemble a 2-tuple of PartialConfigs by...
-                .and_then(|proj| {
+                .map(|proj| {
-                    Ok((
+                    (
                         // 4-1. Passing in the project-specific PartialConfig
                         proj.project_path(project),
                         // 4-2. Getting and converting to PartialConfig, or returning any Err() if one appears.
                         get_table(cfg_table, "all")
                             .and_then(PartialConfig::try_from)
                             .unwrap_or(PartialConfig::default()),
-                    ))
+                    )
                 })
                 .map(|pair| pair.0.merge(pair.1))
         })

src/lib.rs

@@ -23,6 +23,8 @@ pub enum Error {
     Placeholder,     // TODO: Enumerate error modes
     MissingGiteaUrl, // the gitea URL wasn't specified on the CLI, env, or config file.
     MissingRepoFRQN, // either the owner, repo, or both weren't specified in the loaded PartialConfig
+    MissingRepoOwner,
+    MissingRepoName,
     WrappedConfigErr(config::Error),
     WrappedReqwestErr(reqwest::Error),
     MissingAuthToken,

src/main.rs

@@ -1,4 +1,4 @@
-use std::path;
+use std::path::{self, PathBuf};
 
 use gt_tool::cli::Args;
 use gt_tool::structs::release::{CreateReleaseOption, Release};
@@ -12,12 +12,15 @@ use reqwest::header::ACCEPT;
 async fn main() -> Result<(), gt_tool::Error> {
     let args = Args::parse();
 
-    // TODO: Heuristics to guess project path
+    let project_path =
-    // See issue #8: https://git.gelvin.dev/robert/gt-tool/issues/8
+        args.project
-    let pwd = std::env::current_dir()
+            .map(PathBuf::from)
-        .map_err(|_e| gt_tool::Error::WrappedConfigErr(gt_tool::config::Error::CouldntReadFile))?;
+            .unwrap_or(std::env::current_dir().map_err(|_e| {
+                gt_tool::Error::WrappedConfigErr(gt_tool::config::Error::CouldntReadFile)
+            })?);
     let config = gt_tool::config::get_config(
-        pwd.to_str()
+        project_path
+            .to_str()
             .expect("I assumed the path can be UTF-8, but that didn't work out..."),
         gt_tool::config::default_paths(),
     )?;
@@ -27,21 +30,19 @@ async fn main() -> Result<(), gt_tool::Error> {
         .gitea_url
         .or(config.gitea_url)
         .ok_or(gt_tool::Error::MissingGiteaUrl)?;
-    // Config files split the repo FQRN into "owner" and "repo" (confusing naming, sorry)
+
-    // These must be merged back together and passed along.
+    let owner = args
-    let conf_fqrn = config
         .owner
-        .ok_or(gt_tool::Error::MissingRepoFRQN)
+        .or(config.owner)
-        .and_then(|mut own| {
+        .ok_or(gt_tool::Error::MissingRepoOwner)?;
-            let repo = config.repo.ok_or(gt_tool::Error::MissingRepoFRQN)?;
+
-            own.push_str("/");
+    let repo = args
-            own.push_str(&repo);
-            Ok(own)
-        });
-    let repo_fqrn = args
         .repo
-        .ok_or(gt_tool::Error::MissingRepoFRQN)
+        .or(config.repo)
-        .or(conf_fqrn)?;
+        .or_else(infer_repo)
+        .ok_or(gt_tool::Error::MissingRepoName)?;
+
+    let repo_fqrn = format!("{owner}/{repo}");
 
     let mut headers = reqwest::header::HeaderMap::new();
     headers.append(ACCEPT, header::HeaderValue::from_static("application/json"));
@@ -67,7 +68,7 @@ async fn main() -> Result<(), gt_tool::Error> {
                 releases.iter().rev().map(|release| release.colorized()),
                 String::from(""),
             )
-            .map(|release| println!("{}", release))
+            .map(|release| println!("{release}"))
             .fold((), |_, _| ());
         }
         gt_tool::cli::Commands::CreateRelease {
@@ -171,3 +172,10 @@ fn match_release_by_tag(tag: &String, releases: Vec<Release>) -> Option<Release>
     }
     release
 }
+
+fn infer_repo() -> Option<String> {
+    let pwd = std::env::current_dir().ok()?;
+    let file_name = pwd.file_name()?;
+    let file_name_string = file_name.to_str()?;
+    Some(String::from(file_name_string))
+}