Challenge repo init command #30

cacama-valvata · 2024-11-15T17:12:16Z

Opening a premature PR on this so that I can get midway feedback and get most of my "TODO" questions answered this Sunday (not all of the TODOs are for y'all but most of them are, feel free to comment on any you want to give insight on). Please add your answers to the TODOs via comments in a review on this PR since I can't be there this Sunday

cacama-valvata · 2024-11-15T17:15:03Z

clarification: i do not care about code formatting feedback, such as the compiler warnings for the structs or the cargo fmt fails. I will deal with those after all implementation is done.

detjensrobert

Structure comments:

So far, I've tried to keep the bulk of the logic for comands in their own folders, and run() orchestrates which thing to call based on the command line flags (i.e. build::run() calls build_image() and then push_images() if --push was given). I think the *_init() functions and the struct definitions should go in their own folder/file to follow this. Thoughts from the rest of the team?

src/commands/init.rs

src/cli.rs

src/commands/init.rs

cacama-valvata · 2025-04-10T01:59:32Z

Structure comments:

* So far, I've tried to keep the bulk of the logic for comands in their own folders, and `run()` orchestrates which thing to call based on the command line flags (i.e. `build::run()` calls build_image() and then push_images() if `--push` was given). I think the `*_init()` functions and the struct definitions should go in their own folder/file to follow this. Thoughts from the rest of the team?

done

cacama-valvata · 2025-04-10T02:06:34Z

Since this PR is so out of date with the main branch, I have moved all of these changes to branch af/init-command2. Once that other branch is merged in, I will close this PR.

…roblem' style

…ssages

…umber identifier

Signed-off-by: Robert Detjens <github@detjens.dev>

We already have an existing struct used to parse the rcds.yaml config, use that to build the example/interactive config instead of creating an almost-identical struct. So far this is only done for the example values / non-interactive init. Signed-off-by: Robert Detjens <github@detjens.dev>

Signed-off-by: Robert Detjens <github@detjens.dev>

Having this be a string is more user friendly than a number, and this branch was originally set up to do that. Signed-off-by: Robert Detjens <github@detjens.dev>

Signed-off-by: Robert Detjens <github@detjens.dev>

Blank and placeholder template files should be set explicitly by the user. Signed-off-by: Robert Detjens <github@detjens.dev>

Signed-off-by: Robert Detjens <github@detjens.dev>

serde_yml turns out to be maintained weirdly (issues disabled, weird refactors) and is now archived anyway. _ng is what the community is now recommending. Signed-off-by: Robert Detjens <github@detjens.dev>

detjensrobert · 2025-12-11T04:24:00Z

This is now ready for review again, spruced up and tested.

detjensrobert · 2025-12-11T04:29:58Z

src/init/mod.rs

+    // FORMATTING NOTE: Some of these help messages cause rustfmt to silently
+    // fail to format this struct definition. Commenting out the marked
+    // help_message lines temporarily will let the formatting work.
+    //
+    // Ref:
+    // - https://github.com/rust-lang/rustfmt/issues/6687
+    // - https://github.com/rust-lang/rustfmt/issues/3863


Rustfmt currently has some issues with formatting this file due to line length limitations. The issues linked here have more context (rust-lang/rustfmt#6687, rust-lang/rustfmt#3863) -- TLDR rustfmt silently fails on really long lines/method chains and thus fails to format this file unless the lines marked with // too long to format are commented out.

@cacama-valvata and I discussed offline a while ago about this and he recommended that this is is documented in the Discord rather than a code comment here since this seems unprofessional. I disagree with that point and prefer to have it documented here so that it cannot get lost or forgotten and have to figure this all out again in the future, because this is a bug in rustfmt and not (personally) a code smell.

Do any of the rest of you have thoughts on if this should be documented and where?

TIL this is a problem. I wonder how often it's happened to me and I never noticed before?

I tried format_strings with the nightly toolchain and it doesn't help here. I don't think it's worth breaking the strings manually, either. I think the status quo is fine even if the too long to format comments aren't necessary.

Kajmany · 2025-12-11T05:31:24Z

src/init/mod.rs

+                    .with_help_message(
+                        "The username that the cluster will use to pull locally-built containers.",
+                    )


I would personally just use a regex to comment these all out at once so I could format. This is the only help message that's not contained on a single line. Not a big deal to change it manually and do that.

detjensrobert

Also a note: the placeholder/blank config structs could be done via the Default trait on the object, but only one of them can so I have not done that. Should one of them be the Default, and if so which?

src/init/mod.rs

Signed-off-by: Robert Detjens <github@detjens.dev>

cacama-valvata requested a review from detjensrobert November 15, 2024 17:12

detjensrobert reviewed Nov 17, 2024

View reviewed changes

detjensrobert changed the title ~~af/init command~~ Challenge repo init command Sep 27, 2025

cacama-valvata and others added 10 commits September 27, 2025 12:14

init command main workflow

196504a

init command, formatted

082ae15

init command, lump external-dns configuration options into 'not our p…

0346bf3

…roblem' style

init cmd added inquire placeholders and cleaned up prompt and help me…

ce58111

…ssages

init command - allowed difficulty class to be a string instead of a n…

5b9b11e

…umber identifier

changed structs to upper pascal case

cbe9e94

cleaning up & addressing robert's feedback in the old branch/PR

cb36287

Fix result handling in init command runner

b75b3d6

Signed-off-by: Robert Detjens <github@detjens.dev>

Clippy fixes, use Default trait for blank

4b3723c

Signed-off-by: Robert Detjens <github@detjens.dev>

Tracing logs and use render_strict helper

bdfd2bd

Signed-off-by: Robert Detjens <github@detjens.dev>

detjensrobert force-pushed the af/init-command branch 2 times, most recently from 2510f36 to bdfd2bd Compare September 27, 2025 19:49

detjensrobert added 12 commits September 28, 2025 13:34

use to_string, inquire default values

77498dc

Signed-off-by: Robert Detjens <github@detjens.dev>

simplify init imports

fe18a8e

Signed-off-by: Robert Detjens <github@detjens.dev>

Show external-dns config notice as warning

72dcc88

Signed-off-by: Robert Detjens <github@detjens.dev>

Use our internal config structs for init handling -- blank init

e4368cc

Signed-off-by: Robert Detjens <github@detjens.dev>

Convert points difficulty category name to a string

bba1d48

Having this be a string is more user friendly than a number, and this branch was originally set up to do that. Signed-off-by: Robert Detjens <github@detjens.dev>

Use our internal config structs for init handling -- interactive prompts

c368a4d

Signed-off-by: Robert Detjens <github@detjens.dev>

Update rcds config template with help comments and use new structs

5c2316e

Signed-off-by: Robert Detjens <github@detjens.dev>

Handle empty profile/points correctly

6569a5e

Signed-off-by: Robert Detjens <github@detjens.dev>

Add trailing template comment to preserve trailing newline when blank

2221222

Signed-off-by: Robert Detjens <github@detjens.dev>

Make default init behaviour interactive

3cdf345

Blank and placeholder template files should be set explicitly by the user. Signed-off-by: Robert Detjens <github@detjens.dev>

Fix blank points and reuse default tag format from parsing

0fbb636

Signed-off-by: Robert Detjens <github@detjens.dev>

Switch to serde_yaml_ng

ef57447

serde_yml turns out to be maintained weirdly (issues disabled, weird refactors) and is now archived anyway. _ng is what the community is now recommending. Signed-off-by: Robert Detjens <github@detjens.dev>

detjensrobert requested a review from a team December 11, 2025 04:24

detjensrobert reviewed Dec 11, 2025

View reviewed changes

Kajmany reviewed Dec 11, 2025

View reviewed changes

detjensrobert reviewed Dec 11, 2025

View reviewed changes

Kajmany reviewed Dec 11, 2025

View reviewed changes

src/init/mod.rs Show resolved Hide resolved

detjensrobert added 7 commits December 11, 2025 00:16

format interactive prompt structure, document rustfmt failings

f779fea

Signed-off-by: Robert Detjens <github@detjens.dev>

Prompt user for tag format

05a31fb

Signed-off-by: Robert Detjens <github@detjens.dev>

reword formatting comment

7873bb2

Signed-off-by: Robert Detjens <github@detjens.dev>

Add reference link to docs site before prompting

a778186

Signed-off-by: Robert Detjens <github@detjens.dev>

Consistent punctuation on prompts

adcee17

Signed-off-by: Robert Detjens <github@detjens.dev>

Fix rendering of multiple difficulty modes in init template

3e20f72

Signed-off-by: Robert Detjens <github@detjens.dev>

add tests for blank/placeholder init templating

0a82506

Signed-off-by: Robert Detjens <github@detjens.dev>

detjensrobert force-pushed the af/init-command branch from b1e0a60 to 0a82506 Compare December 11, 2025 09:03

Challenge repo init command #30

Are you sure you want to change the base?

Challenge repo init command #30

Uh oh!

Conversation

cacama-valvata commented Nov 15, 2024

Uh oh!

cacama-valvata commented Nov 15, 2024

Uh oh!

detjensrobert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cacama-valvata commented Apr 10, 2025

Uh oh!

cacama-valvata commented Apr 10, 2025

Uh oh!

detjensrobert commented Dec 11, 2025

Uh oh!

detjensrobert Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kajmany Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

Kajmany Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

detjensrobert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

detjensrobert Dec 11, 2025 •

edited

Loading