Commit Graph

14 Commits

Author SHA1 Message Date
b952e40060 Revise explanation of --project option
I need to introduce the idea that "projects" are actually file paths,
and that these paths are the keys for the key-value stores that are the
config files.

...but without saying "HashMap" because that's really an implementation
detail.
2025-07-21 16:14:47 -05:00
4b9257a9a7 Rename remaining CLI arg sections
The previous text was pretty ugly and not particularly useful to catch
the eye when looking for relevant sections.
2025-07-21 16:13:46 -05:00
d34eda77dc Delete the old CLI option sections 2025-07-21 16:12:56 -05:00
3315c18ed2 New 'authentication' section
The auth tokens can now be loaded from the config files, so I need to
mention that.

I took the opportunity to revise the explanation of when auth is
required. Now it has a more obvious example of how it depends on
instance configuration.
2025-07-21 16:09:12 -05:00
0e7bca80cb Create a short, complete explanation of req. info.
I don't need to have nearly so much information explaining how to use
optional command line arguments. The quirk about the "repo" needing to
be a URL fragment somewhat justified the extra explanation, but that's
gone now.

Instead, a short, up-front section stating which bits are required and
where the program will try to get them.
2025-07-21 16:08:08 -05:00
5bd2862498 Update usage printout 2025-07-21 15:47:23 -05:00
e954a2b09a Drop notice about CLI not having "repo" & "owner" 2025-07-21 14:54:16 -05:00
c1019afa7a Write configuration guide in the README 2025-07-21 14:04:04 -05:00
1a619d7bb4 Update CLI usage guide, add project lookup guide
There's a new inconsistency, however. The previous URL and FQRN
arguments are no longer mandatory but their description makes it seem
as though they are.
2025-07-21 14:04:01 -05:00
a23bdf3e34 Make the README title singular
It's not the "gt-tools" anymore, so maybe the README should match.
2025-07-05 17:21:59 -05:00
b200785e71 ... and the unit testing notes in README.md 2025-06-08 10:40:54 -05:00
e7e8a2871b Add unit test for release_attachment function
I need some kind of automated testing, and Cargo has a test framework
built-in. This isn't the smartest test and depends upon another
test-less function.

Building a mocking environment is possible but means I'm trying to
emulate some behavior I don't fully understand -- that's why I need
tests in the first place. That path leads to tests for my tests and
that's stupid.

Instead, I'm having the test read config from the environment and hit a
real Gitea server. It's up to the user to ensure they have one.
2025-06-04 11:14:12 -05:00
442c8a97f8 Create a usage guide 2025-06-01 13:27:45 -05:00
3171c89248 Initial commit
Starting up a new project for interfacing with Gitea's API from the
command line.
2025-05-22 18:22:05 -05:00