Skip to content

Commit 8728d59

Browse files
Add readme to artiaa_auth and bump foreman version (#96)
This PR looks to add readme to artiaa_auth so we can publish it as an individual crate for Foreman to depend on
1 parent 70b2cc9 commit 8728d59

File tree

4 files changed

+38
-3
lines changed

4 files changed

+38
-3
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ default-members = [".", "artiaa_auth"]
66
[package]
77
name = "foreman"
88
description = "Toolchain manager for simple binary tools"
9-
version = "1.6.2"
9+
version = "1.6.3"
1010
authors = [
1111
"Lucien Greathouse <me@lpghatguy.com>",
1212
"Matt Hargett <plaztiksyke@gmail.com>",

artiaa_auth/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# artiaa_auth
2+
Reads artifactory authentication using the following schema:
3+
4+
```
5+
{
6+
"$schema": "https://json-schema.org/draft/2019-09/schema",
7+
"type": "object",
8+
"title": "ArtiAA Token File Format",
9+
"description": "This is the format of the ArtiAA Token File, a standard output that contains the Artifactory tokens for the user. ",
10+
"properties": {
11+
"tokens": {
12+
"title": "Tokens URL Map",
13+
"description": "Map of URLs and the credentials that apply to them.\nThe key of each value is the base domain URL the credential applies to, such as 'artifactory.rbx.com'.\nArtiAA will add an entry for each URL it has been logged into.",
14+
"type": "object",
15+
"additionalProperties": {
16+
"title": "URL Token Element",
17+
"type": "object",
18+
"properties": {
19+
"username": {
20+
"title": "Username",
21+
"description": "The username to use for accessing the server, if a username is necessary.\nMay be an empty string.",
22+
"type": "string"
23+
},
24+
"token": {
25+
"title": "Token",
26+
"description": "The token to use for accessing the server.",
27+
"type": "string"
28+
}
29+
},
30+
"additionalProperties": false
31+
}
32+
}
33+
}
34+
}
35+
```

tests/snapshots/help_command.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ source: tests/cli.rs
33
assertion_line: 100
44
expression: content
55
---
6-
foreman 1.6.2
6+
foreman 1.6.3
77

88
USAGE:
99
foreman [FLAGS] <SUBCOMMAND>

0 commit comments

Comments
 (0)