Deprecate all packages in in-toto-golang#401
Conversation
4beff12 to
203f2cd
Compare
This commit deprecates all packages within in-toto-golang and the most important methods. Signed-off-by: Christian Rebischke <chris@shibumi.dev>
203f2cd to
db8c5d6
Compare
Pull Request Test Coverage Report for Build 14146477469Details
💛 - Coveralls |
06kellyjac
left a comment
There was a problem hiding this comment.
progress on #369
Glad to see this moving, just one thought.
| - errors while marshalling | ||
| - unsupported key types | ||
|
|
||
| Deprecated: This method has been deprecated. |
There was a problem hiding this comment.
I understand having just "This method has been deprecated." for where there's a whole package deprecation note.
But for packages where only specific functions are deprecated so far do we want a longer comment which links to go-witness?
There was a problem hiding this comment.
I am not sure how far we want to go. At first I thought of putting the deprecation notice only on package level, but then I realized that many IDEs and code editors do not pick up these deprecation notices and they only pick it up for method comments.
Adding a comment to EVERY method seems really toilsome for me, so I tried adding it only to the most important method to make clear that we deprecate this.
We can link to go-witness from there as well, but I kinda want to avoid putting a big notice on every exported variable and method.
|
Maybe a slightly reckless solution, but I'm half tempted to cut a /v2 module release with just the stuff removed to see where the complaints are. My sense is that most of the consumption of this repo is for provenance / attestation structs and I'm curious if the workflows are in fact used. If we cut a breaking release and bump the major version, we can at least see who gets broken and determine if we want to cut subsequent 1.x releases? |
This commit deprecates all packages within in-toto-golang and the most important methods.