andir/npins

Pinning specific commits in a GH repo

Opened this issue · 5 comments

eclairevoyant commented

To add a GH source at a specific commit is explained as

npins add --name <name> github <owner> <repo> -b <branch> --at <rev>

In my case, I'd like to keep that source pinned to <rev> even after running npins update. Is this possible?

piegamesde commented

Sure, why not. One way I could see to handle this:

  • Add a pinned attribute to each pin entry
  • Add a pin and unpin subcommand to the CLI to modify that value
  • When updating, skip pinned entries
  • Maybe add a --pin flag to the add subcommand which will set pinned to true on creation

My only worry is that this terminology could be confusing due to the double meaning of "pinning". Not sure how else to call it though

An alternative would be to allow specifying which pins to skip while updating. Currently we can say update foo bar to only update certain pins, so maybe some --skip or --exclude flag could be added to do the opposite. I think I'd personally like this solution a bit more, but not sure how well it would fit your use case.

eclairevoyant commented

My use case is to prevent updating inputs when I know they're broken after a certain rev, i.e. I'd pin to the last known working rev.

I would lean towards the first option, since it would:

  • ensure I don't accidentally update the rev because I forgot to pass the flag
  • explicitly indicate that I'd like it at that rev, for whatever reason

I do see the issue about calling it a "pin", though 😕

piegamesde commented

How about "freeze"/"frozen"?

eclairevoyant commented

Yes, I think that makes sense.

andir commented

@eclairevoyant mind having a look at #78 and testing it?

  • 👍1