allow registering from a dirty repo

[aplavin]

I often want to register a package dir that is dirty – typically, when I have some example notebooks in the dir and playing with them. In the simplest case, it requires manually stashing & unstashing changes. But even this doesn't always work when notebooks are currently open in Pluto because it updates some fields such as version continuously.

Would be nice to add a flag like allow_dirty (open to name suggestions) that would just register the current commit and ignore the git repo being dirty.

Will add a test if this addition is welcome!

[GunnarFarneback]

The main concern with allowing the package to be dirty is if Project.toml is dirty and there is a mismatch between the data read from file and the data recorded in the tree hash. Possibly that (i.e. Project.toml being dirty) should still not be allowed.

This patch conflates dirtiness of package and registry, which are quite different cases. For the registry I think allowing it to be dirty if and only if commit is false is still the right thing to do. Consequently the argument name should be more clear that it refers to the package.

The new argument needs documentation in the docstring.

[aplavin]

Totally agree that such a behavior has a potential for mismatches, and shouldn't be the default. As an option though, ignoring dirty files is definitely useful.

Renamed the argument, made it only affect the package dir, and added to the docs + tests.

[GunnarFarneback]

I'll merge this as is and will follow up with some additions before I register a new version. Thanks for the contribution.

[aplavin]

Thanks!
LocalRegistry is generally very nice to use, this is the only significant inconvenience I noticed in extensive use over multiple years :)

[aplavin]

Still cannot use this argument... Could you please register the new version?

[GunnarFarneback]

Sorry, have been sidetracked with other things. I'll get back to it.