Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ an individual is officially representing the community in public spaces.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement via
[GitHub Issues](https://github.com/OpusProjects/unified-gitops/issues). All complaints will be reviewed and investigated
[GitHub Issues](https://github.com/OpusProjects/git/issues). All complaints will be reviewed and investigated
promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
20 changes: 10 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "unified-git"
name = "git-rs"
description = "Git checkouts for services that run code from a repository: clone, pull, commits and export, with credentials kept off the command line"
version = "0.1.0"
edition = "2024"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Git keeps a local checkout of a repository up to date and reads from it: which c
what a pull brought, and a folder as it was at an older commit. It drives the `git` binary, so what
it does is what `git -C <dir> log` shows, and it keeps credentials off the command line.

One crate, `unified-git`: the `GitPort` trait a service codes against, `CliGit` that implements it,
One crate, `git-rs`: the `GitPort` trait a service codes against, `CliGit` that implements it,
and the functions that remove credentials written into an address before it is shown or logged.

---
Expand Down
4 changes: 2 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ local copy before anything is released.

## Layout

One crate, `unified-git`, at the root of the repository.
One crate, `git-rs`, at the root of the repository.

```
Cargo.toml # the crate: version, MSRV, dependencies
Expand Down Expand Up @@ -78,7 +78,7 @@ With this repository checked out next to the service, add a `[patch]` section to

```toml
[patch."https://github.com/OpusProjects/git"]
unified-git = { path = "../git" }
git-rs = { path = "../git" }
```

Then run the service's own gates (`cargo clippy --all-targets -- -D warnings` and `cargo test`):
Expand Down
4 changes: 2 additions & 2 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,10 @@ gh workflow run build.yaml --ref release-please--branches--main
A release here changes nothing in a service until it names the new tag.

In each service that uses the crate, open a `build:` pull request (`build: move to git v0.2.0`)
that changes the `tag` of `unified-git` in `Cargo.toml` and refreshes the lockfile:
that changes the `tag` of `git-rs` in `Cargo.toml` and refreshes the lockfile:

```bash
cargo update -p unified-git
cargo update -p git-rs
```

The service's CI is the check that the release works there. A release that changes what a person
Expand Down
6 changes: 3 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage

How a service uses the `unified-git` crate: the trait it codes against, the adapter that implements
How a service uses the `git-rs` crate: the trait it codes against, the adapter that implements
it, how credentials reach git, and what each operation does.

- [Depending on the crate](#depending-on-the-crate)
Expand All @@ -20,7 +20,7 @@ it, how credentials reach git, and what each operation does.
A service names a release tag of this repository in its `Cargo.toml`, never a branch.

```toml
unified-git = { git = "https://github.com/OpusProjects/git", tag = "v0.1.0" }
git-rs = { git = "https://github.com/OpusProjects/git", tag = "v0.1.0" }
```

The machine that runs the service needs the `git` binary (2.31 or newer, for the credential
Expand All @@ -34,7 +34,7 @@ A service holds a `GitPort` and builds a `CliGit` once, where it wires its adapt

```rust
use std::sync::Arc;
use unified_git::{CliGit, GitPort, Remote};
use git_rs::{CliGit, GitPort, Remote};

let git: Arc<dyn GitPort> = Arc::new(CliGit::new());
let remote = Remote { url: project.git_url.clone(), branch: project.branch.clone() };
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// unified-git — local checkouts of a git repository, kept up to date.
// git-rs — local checkouts of a git repository, kept up to date.
//
// A service that runs scripts or reads files from a repository needs the same
// few things: clone it, pull it, know which commit it is at, see what a pull
Expand Down
2 changes: 1 addition & 1 deletion tests/cli_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
use std::collections::HashMap;
use std::path::Path;

use unified_git::{CliGit, GitPort, Remote};
use git_rs::{CliGit, GitPort, Remote};

pub async fn run(dir: &Path, args: &[&str]) {
let status = tokio::process::Command::new("git")
Expand Down
2 changes: 1 addition & 1 deletion tests/no_git_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
use std::collections::HashMap;
use std::path::Path;

use unified_git::{CliGit, GitPort, Remote};
use git_rs::{CliGit, GitPort, Remote};

#[tokio::test]
async fn every_operation_says_git_is_missing() {
Expand Down
2 changes: 1 addition & 1 deletion tests/no_tar_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
use std::collections::HashMap;
use std::path::Path;

use unified_git::{CliGit, GitPort, Remote};
use git_rs::{CliGit, GitPort, Remote};

async fn git(dir: &Path, args: &[&str]) {
let status = tokio::process::Command::new("git")
Expand Down
Loading