Skip to content
This repository has been archived by the owner on Apr 9, 2024. It is now read-only.

Better package names in pkg #229

Closed
rbehjati opened this issue May 5, 2023 · 0 comments · Fixed by #230
Closed

Better package names in pkg #229

rbehjati opened this issue May 5, 2023 · 0 comments · Fixed by #230
Assignees

Comments

@rbehjati
Copy link
Contributor

rbehjati commented May 5, 2023

Under the pkg folder we currently have the following packages:

  • amber: containing claims and endorsements structs
  • intoto: Containing intoto statement and slsa provenance structs
  • types: containing generic functionality for parsing provenances

This issue suggests renaming the packages amber and types.

amber is a legacy package name that we no longer use anywhere in the documentation. This package can be renamed to claims. Alternatively, this package can be split into two: claims and endorsements instead of having the separation only at the file-level.

types is a very generic name. This could be renamed to validation, or provenancevalidation but that is too long for a package name.

@tiziano88 @mariaschett What do you think? If you think this is a good change, I'll do it and then create a v1 release.

@rbehjati rbehjati self-assigned this May 5, 2023
@rbehjati rbehjati mentioned this issue May 11, 2023
2 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant