Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readme to artiaa_auth and bump foreman version #96

Merged
merged 3 commits into from
May 1, 2024
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 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
Expand Up @@ -6,7 +6,7 @@ default-members = [".", "artiaa_auth"]
[package]
name = "foreman"
description = "Toolchain manager for simple binary tools"
version = "1.6.2"
version = "1.6.3"
authors = [
"Lucien Greathouse <[email protected]>",
"Matt Hargett <[email protected]>",
Expand Down
35 changes: 35 additions & 0 deletions artiaa_auth/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# artiaa_auth
Reads artifactory authentication using the following schema:

```
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"type": "object",
"title": "ArtiAA Token File Format",
"description": "This is the format of the ArtiAA Token File, a standard output that contains the Artifactory tokens for the user. ",
"properties": {
"tokens": {
"title": "Tokens URL Map",
"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.",
"type": "object",
"additionalProperties": {
"title": "URL Token Element",
"type": "object",
"properties": {
"username": {
"title": "Username",
"description": "The username to use for accessing the server, if a username is necessary.\nMay be an empty string.",
"type": "string"
},
"token": {
"title": "Token",
"description": "The token to use for accessing the server.",
"type": "string"
}
},
"additionalProperties": false
}
}
}
}
```
2 changes: 1 addition & 1 deletion tests/snapshots/help_command.snap
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ source: tests/cli.rs
assertion_line: 100
expression: content
---
foreman 1.6.2
foreman 1.6.3

USAGE:
foreman [FLAGS] <SUBCOMMAND>
Expand Down
Loading