Compare commits
4 Commits
ab8b21d01c
...
new-readme
| Author | SHA1 | Date | |
|---|---|---|---|
| ef46e79674 | |||
| c5c5598fb7 | |||
| 9e47cb72d5 | |||
| ff2286f44b |
17
Cargo.toml
17
Cargo.toml
@@ -1,7 +1,12 @@
|
||||
[package]
|
||||
name = "gt-tool"
|
||||
version = "4.0.0-dev"
|
||||
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.5.23", features = ["derive", "env"] }
|
||||
@@ -11,13 +16,3 @@ reqwest = { version = "0.12.15", features = ["json", "stream", "multipart"] }
|
||||
serde = { version = "1.0.217", features = ["derive"] }
|
||||
tokio = { version = "1.43.1", features = ["macros", "rt-multi-thread"] }
|
||||
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"
|
||||
|
||||
@@ -1,6 +1,12 @@
|
||||
# gt-tool
|
||||
|
||||
CLI tools for interacting with the Gitea API. Use interactively to talk to your Gitea instance, or automatically via a CI/CD pipeline.
|
||||
A CLI tool for interacting with the Gitea API. List existing releases, create new ones, and attach release-items (files) to them. It can be used interactively as one publishes their work, or automatically as part of a CI/CD pipeline.
|
||||
|
||||
## Why this thing exists
|
||||
|
||||
This program exists because I find GitHub Actions to be an insufficient system. There is no official "release-attachment" workflow. I have to either make my own or find someone else's. Since there is no standard Workflow for this task, the [Gitea version](https://gitea.com/actions/gitea-release-action) has a different API. Since I can only use branches, tags, or exact commit hashes, my dependency resolution is often manual or happens in surprising ways (e.g.: force pushing a new version tag). Adjacent to this is the issue that lots of dependencies are "assumed" and cannot be named -- like how the Ubuntu base image contains NodeJS, even if I never ask to install it. Finally, I can't easily execute or re-execute the workflows. There is no "run Action" button and I can't run any of it from my dev machine.
|
||||
|
||||
So I figured I'll make my own as a learning exercise and try to address as many of those problems as I can. The key is recognizing that a CI/CD platform needs a package manager. I like Debian, so I will stand on its package manager, although it might be better to pick NixOS or Gentoo. A GH Workflow which depends on this tool needs only to record it's name -- declarative build dependencies! This feature extends to the entire Debian container, automatically giving me full-system dependency knowledge. Updating the build environment is exactly like updating a normal Linux host because it *is* a normal Linux host. Lastly, it's also *a normal CLI program* so you can use it from your own dev workstation. There is no need for a "run Action" button.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@@ -1,40 +1,4 @@
|
||||
use crate::structs::package::{Package, PackageType};
|
||||
|
||||
/// Gets all packages of an owner
|
||||
///
|
||||
/// https://github.com/go-gitea/gitea/blob/main/routers/api/v1/packages/package.go#L22
|
||||
///
|
||||
/// Matches the route `GET /packages/{owner}`
|
||||
pub async fn list_packages(
|
||||
client: &reqwest::Client,
|
||||
gitea_url: &str,
|
||||
owner: &str,
|
||||
pkg_type: Option<PackageType>,
|
||||
) -> crate::Result<Vec<Package>> {
|
||||
let request_url = format!("{gitea_url}/api/v1/packages/{owner}");
|
||||
// add the query parameter only when a package type filter has been set.
|
||||
let request_url = if let Some(pkg_type) = pkg_type {
|
||||
let pkg_type = pkg_type.to_string();
|
||||
format!("{request_url}?type={pkg_type}")
|
||||
} else {
|
||||
request_url
|
||||
};
|
||||
let req = client.get(request_url).send().await;
|
||||
let response = req.map_err(crate::Error::WrappedReqwestErr)?;
|
||||
|
||||
if response.status().is_success() {
|
||||
let release_list = response
|
||||
.json::<Vec<Package>>()
|
||||
.await
|
||||
.map_err(crate::Error::WrappedReqwestErr)?;
|
||||
return Ok(release_list);
|
||||
} else if response.status().is_client_error() {
|
||||
let mesg = crate::decode_client_error(response).await?;
|
||||
return Err(crate::Error::ApiErrorMessage(mesg));
|
||||
}
|
||||
panic!("Reached the end of `api::list_packages()` without matching a return pathway.");
|
||||
}
|
||||
|
||||
pub fn list_packages() {}
|
||||
pub fn get_packages() {}
|
||||
pub fn delete_package() {}
|
||||
pub fn list_package_files() {}
|
||||
|
||||
@@ -44,5 +44,4 @@ pub enum Commands {
|
||||
#[arg()]
|
||||
files: Vec<String>,
|
||||
},
|
||||
ListPackages,
|
||||
}
|
||||
|
||||
10
src/main.rs
10
src/main.rs
@@ -134,16 +134,6 @@ async fn main() -> Result<(), gt_tool::Error> {
|
||||
return Err(gt_tool::Error::NoSuchRelease);
|
||||
}
|
||||
}
|
||||
gt_tool::cli::Commands::ListPackages => {
|
||||
let packages = gt_tool::api::packages::list_packages(&client, &gitea_url, &owner, None).await?;
|
||||
itertools::Itertools::intersperse(
|
||||
packages
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|pkg| pkg.colorized()),
|
||||
String::from("")
|
||||
).for_each(|package| println!("{package}"));
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
pub mod package;
|
||||
pub mod release;
|
||||
pub mod repo;
|
||||
|
||||
|
||||
@@ -1,95 +0,0 @@
|
||||
use colored::Colorize;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::structs::release::Author;
|
||||
|
||||
/// Represents the package as described by JSON
|
||||
///
|
||||
/// https://github.com/go-gitea/gitea/blob/main/modules/structs/package.go
|
||||
#[derive(Debug, Deserialize, Serialize)]
|
||||
pub struct Package {
|
||||
created_at: String, // TODO: Datetime struct
|
||||
creator: Author,
|
||||
html_url: String,
|
||||
id: u64,
|
||||
name: String,
|
||||
owner: Author,
|
||||
#[serde(skip)]
|
||||
repository: (), // TODO: Create a `struct Repository`
|
||||
#[serde(rename = "type")] // field is "type" in JSON & Go, but that's a
|
||||
pkg_type: PackageType, // keyword in Rust so we need to serde-rename it.
|
||||
version: String,
|
||||
}
|
||||
|
||||
impl Package {
|
||||
pub fn colorized(&self) -> String {
|
||||
let name = "Name:".green().bold();
|
||||
let version = "Ver:".green();
|
||||
let pkg_type = "Type:".white();
|
||||
|
||||
format!(
|
||||
"{name} {}
|
||||
{version} {}, {pkg_type} {}",
|
||||
self.name,
|
||||
self.version,
|
||||
self.pkg_type.to_string(),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/// A marker for the kind of package being handled.
|
||||
#[derive(Debug, Deserialize, Serialize)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum PackageType {
|
||||
Alpine,
|
||||
Arch,
|
||||
Cargo,
|
||||
Chef,
|
||||
Composer,
|
||||
Conan,
|
||||
Conda,
|
||||
Container,
|
||||
Cran,
|
||||
Debian,
|
||||
Generic,
|
||||
Go,
|
||||
Helm,
|
||||
Maven,
|
||||
Npm,
|
||||
Nuget,
|
||||
Pub,
|
||||
PyPi,
|
||||
Rpm,
|
||||
RubyGems,
|
||||
Swift,
|
||||
Vagrant,
|
||||
}
|
||||
|
||||
impl ToString for PackageType {
|
||||
fn to_string(&self) -> String {
|
||||
match self {
|
||||
PackageType::Alpine => "alpine".into(),
|
||||
PackageType::Arch => "arch".into(),
|
||||
PackageType::Cargo => "cargo".into(),
|
||||
PackageType::Chef => "chef".into(),
|
||||
PackageType::Composer => "composer".into(),
|
||||
PackageType::Conan => "conan".into(),
|
||||
PackageType::Conda => "conda".into(),
|
||||
PackageType::Container => "container".into(),
|
||||
PackageType::Cran => "cran".into(),
|
||||
PackageType::Debian => "debian".into(),
|
||||
PackageType::Generic => "generic".into(),
|
||||
PackageType::Go => "go".into(),
|
||||
PackageType::Helm => "helm".into(),
|
||||
PackageType::Maven => "maven".into(),
|
||||
PackageType::Npm => "npm".into(),
|
||||
PackageType::Nuget => "nuget".into(),
|
||||
PackageType::Pub => "pub".into(),
|
||||
PackageType::PyPi => "pypi".into(),
|
||||
PackageType::Rpm => "rpm".into(),
|
||||
PackageType::RubyGems => "rubygems".into(),
|
||||
PackageType::Swift => "swift".into(),
|
||||
PackageType::Vagrant => "vagrant".into(),
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user