Icarus-Mod-Tools 1.3.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGES.md +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +60 -8
- data/icarus-mod-tools.gemspec +1 -1
- data/lib/icarus/mod/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: daeaf600cc95360b7002385ce3c955b75ef0de606893bf5b73d34ce5d76dbba7
|
4
|
+
data.tar.gz: 8ca92cb968f6d7f1cd23a14fc3a393b32d8acac0ac10039b91d8265a5a8bdd9d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '094d0be08425875bbdc181e3a01f70b63b082e08903ab9d8da6795e0813c85102d34a0c37e37e7de4319f8ae7d37e372b37f2cb1f4a2669d873814a9c45f9211'
|
7
|
+
data.tar.gz: c9904e4b40ba8f8bd72818146c8edfa9c07d9150152aa087e9c2aa13292fd20425b4ef85426dada71e99ada4983ac40c347889c8c2bafef9e508bf0e1ebd2ee2
|
data/CHANGES.md
CHANGED
@@ -4,21 +4,21 @@ All notable changes to this project will be documented in this file.
|
|
4
4
|
|
5
5
|
## History (reverse chronological order)
|
6
6
|
|
7
|
-
### v1.3
|
7
|
+
### v1.3 - 2023-02
|
8
8
|
|
9
9
|
- First public release
|
10
10
|
- Added sorting and filtering to the `list mods` command
|
11
11
|
- Bugfixes
|
12
12
|
|
13
|
-
### v1.2
|
13
|
+
### v1.2 - 2023-01 _[Unreleased]_
|
14
14
|
|
15
15
|
- initial `sync mods` working functionality
|
16
16
|
- Bugfixes
|
17
17
|
|
18
|
-
### v1.1
|
18
|
+
### v1.1 - 2022-12 _[Unreleased]_
|
19
19
|
|
20
20
|
- Initial alpha release
|
21
21
|
|
22
|
-
### v1.0
|
22
|
+
### v1.0 - 2022-12 _[Unreleased]_
|
23
23
|
|
24
24
|
- Development
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,22 +1,74 @@
|
|
1
1
|
# Icarus::Mod::Tools
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
3
|
+
a CLI tool for managing the Icarus Mods Database
|
6
4
|
|
7
5
|
## Installation
|
8
6
|
|
9
|
-
|
7
|
+
`gem install icarus-mod-tools`
|
8
|
+
|
9
|
+
To use this app, you'll need to obtain and create the following ENV environment variables:
|
10
10
|
|
11
|
-
|
11
|
+
```sh
|
12
|
+
export GITHUB_TOKEN=your_github_token
|
13
|
+
export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/Google-keyfile"
|
14
|
+
```
|
12
15
|
|
13
|
-
If
|
16
|
+
If you aren't sure how to obtain these credentials, please see:
|
14
17
|
|
15
|
-
|
18
|
+
- [Google Cloud Platform](https://cloud.google.com/docs/authentication/getting-started)
|
19
|
+
- [GitHub](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
|
16
20
|
|
17
21
|
## Usage
|
18
22
|
|
19
|
-
|
23
|
+
imt [options] [command]
|
24
|
+
|
25
|
+
### Commands
|
26
|
+
|
27
|
+
```sh
|
28
|
+
imt add # Adds entries to the databases
|
29
|
+
imt list # Lists the databases
|
30
|
+
imt sync # Syncs the databases
|
31
|
+
```
|
32
|
+
|
33
|
+
#### `imt add`
|
34
|
+
|
35
|
+
```sh
|
36
|
+
Commands:
|
37
|
+
imt add help [COMMAND] # Describe subcommands or one specific subcommand
|
38
|
+
imt add modinfo # Adds an entry to 'meta/modinfo/list'
|
39
|
+
imt add repos # Adds an entry to 'meta/repos/list'
|
40
|
+
|
41
|
+
Options:
|
42
|
+
-v, [--verbose], [--no-verbose] # Increase verbosity. May be repeated for even more verbosity.
|
43
|
+
# Default: [true]
|
44
|
+
```
|
45
|
+
|
46
|
+
#### `imt list`
|
47
|
+
|
48
|
+
```sh
|
49
|
+
Commands:
|
50
|
+
imt list help [COMMAND] # Describe subcommands or one specific subcommand
|
51
|
+
imt list modinfo # Displays data from 'meta/modinfo/list'
|
52
|
+
imt list mods # Displays data from 'mods'
|
53
|
+
imt list repos # Displays data from 'meta/repos/list'
|
54
|
+
|
55
|
+
Options:
|
56
|
+
-v, [--verbose], [--no-verbose] # Increase verbosity. May be repeated for even more verbosity.
|
57
|
+
# Default: [true]
|
58
|
+
```
|
59
|
+
|
60
|
+
#### `imt sync`
|
61
|
+
|
62
|
+
```sh
|
63
|
+
Commands:
|
64
|
+
imt sync help [COMMAND] # Describe subcommands or one specific subcommand
|
65
|
+
imt sync modinfo # Reads from 'meta/repos/list' and Syncs any modinfo files we find (github only for now)
|
66
|
+
imt sync mods # Reads from 'meta/modinfo/list' and updates the 'mods' database accordingly
|
67
|
+
|
68
|
+
Options:
|
69
|
+
-v, [--verbose], [--no-verbose] # Increase verbosity. May be repeated for even more verbosity.
|
70
|
+
# Default: [true]
|
71
|
+
```
|
20
72
|
|
21
73
|
## Development
|
22
74
|
|
data/icarus-mod-tools.gemspec
CHANGED
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
|
|
15
15
|
|
16
16
|
spec.metadata["homepage_uri"] = spec.homepage
|
17
17
|
spec.metadata["source_code_uri"] = spec.homepage
|
18
|
-
spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGES.md"
|
18
|
+
spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGES.md"
|
19
19
|
spec.metadata["rubygems_mfa_required"] = "true"
|
20
20
|
|
21
21
|
# Specify which files should be added to the gem when it is released.
|
data/lib/icarus/mod/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: Icarus-Mod-Tools
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.3.
|
4
|
+
version: 1.3.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Donovan Young
|
@@ -89,7 +89,7 @@ licenses: []
|
|
89
89
|
metadata:
|
90
90
|
homepage_uri: https://github.com/Donovan522/icarus-mod-tools
|
91
91
|
source_code_uri: https://github.com/Donovan522/icarus-mod-tools
|
92
|
-
changelog_uri: https://github.com/Donovan522/icarus-mod-tools/CHANGES.md
|
92
|
+
changelog_uri: https://github.com/Donovan522/icarus-mod-tools/blob/main/CHANGES.md
|
93
93
|
rubygems_mfa_required: 'true'
|
94
94
|
post_install_message:
|
95
95
|
rdoc_options: []
|