#Best practice note: I'm going to adopt

1 messages · Page 1 of 1 (latest)

proud jackal
#

@violet birch FYI moving the discussion here

violet birch
#

Thanks @proud jackal

thinking about it a bit more I think my main objections is not even about the name dev but about moving dagger.json into a subdir - since this goes against one of our goals to make the CLI less verbose

Keeping things at the root allows me to not have to call -m $dir which takes a tiny chip away from the verbosity

proud jackal
violet birch
#

sorry I'm confused :/

move dagger.json to ./dev/dagger.json

Would'nt moving it inside of dev make it required?

proud jackal
#

Yes initially, but then a PR to dagger itself would change the default behavior when you omit -m. With the goal of making -m dev optional

violet birch
#

Thanks for clarifying!

I am curious, did you already consider pipelines instead of dev? since that directory contains all your pipelines and maps nicely to the .github/workflows mental model?

proud jackal
#

yeah I did (and many other words) but from the perspective of a Dagger user today, I think it's too aspirational

#

(the contents of the directory don't mention the word "pipeline" anywhere)

violet birch
proud jackal
#

Yes

#

(but only after my PR is merged so that -m dev is optional)

potent shadow
#

I notice that /dev/ is pretty widely used at the root of a project, so we might disrupt a lot of folks if we insist on it. I'd think something else like dagger/ or maybe or .dagger/ (or maybe pipelines/, but I don't have all the context)

proud jackal
# potent shadow How is this pattern working out? https://github.com/dagger/dagger/blob/main/dev/...

too early to tell, it's an attempt at harmonizing 2 different patterns within our own repo (https://github.com/dagger/dagger/pull/7766#issuecomment-2195022396).

GitHub

This PR combines cleanup tasks to make our development pipelines more pleasant to use and improve:

Rename ./ci to ./dev (to match SDK dev)
Move ./dagger.json to ./dev/dagger.json (to match SDK dev...

potent shadow
#

ah, okay, if the Dagger stuff can peacefully co-exist with other things in the dev/ directory, probably not an issue, right?

proud jackal
potent shadow
#

I was thinking about best practices and what to suggest to Paul Dragoonis and thought of this note from you I'd seen 🙂

proud jackal
#

Basically I acknowledge that this best practice is not fully baked, trying it out to build practical experience with relatively little risk, we can still break this in our own repo if needed