Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TAP 8] Update TAP 8 for clarity and changes in the spec #163

Merged
merged 3 commits into from
Jan 6, 2023

Conversation

mnm678
Copy link
Contributor

@mnm678 mnm678 commented Nov 17, 2022

Notably this pr:

  • specifies that rotate files will be included in snapshot metadata
  • fixes/clarifies references to TAP 3
  • Removes references to rejected TAPs
  • Simplifies the TAP 8 mechanism by not requiring role name changes

Notably this commit:
* specifies that rotate files will be included in snapshot metadata
* fixes/clarifies references to TAP 3
* Removes references to rejected TAPs
* Simplifies the TAP 8 mechanism by not requiring role name changes

Signed-off-by: Marina Moore <mnm678@gmail.com>
JustinCappos
JustinCappos previously approved these changes Nov 17, 2022
Copy link
Member

@JustinCappos JustinCappos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me, but it certainly is a mismatch of edits.

@mnm678
Copy link
Contributor Author

mnm678 commented Nov 17, 2022

Looks fine to me, but it certainly is a mismatch of edits.

It's a collection of minor edits from re-reading this after 4 years of changes to TUF. If there's anything controversial (which I tried to avoid) I can move that into a different pr.

Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thank you. I added a question/clarification but otherwise LGTM.

An additional minor comment: there's some strange line lengths in the edits i.e., line 49 is very long and line 191 is very short. The rest of the file wraps at ~80characters. Should we care about this? If we should, perhaps we could add a linter?

tap8.md Outdated Show resolved Hide resolved
tap8.md Outdated Show resolved Hide resolved
tap8.md Outdated Show resolved Hide resolved
tap8.md Outdated Show resolved Hide resolved
Signed-off-by: Marina Moore <mnm678@gmail.com>
Signed-off-by: Marina Moore <mnm678@gmail.com>
@mnm678
Copy link
Contributor Author

mnm678 commented Jan 4, 2023

This looks great, thank you. I added a question/clarification but otherwise LGTM.

Thanks for the review!

An additional minor comment: there's some strange line lengths in the edits i.e., line 49 is very long and line 191 is very short. The rest of the file wraps at ~80characters. Should we care about this? If we should, perhaps we could add a linter?

I added a commit that cleans this up a bit for this TAP. In the long term it'd be nice to have a consistent stance backed by a linter. The ~80 character lines look nice, but lead to strange diffs when the text is edited, so I'd advocate for line breaks at the sentence or paragraph level.

Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

I added a commit that cleans this up a bit for this TAP. In the long term it'd be nice to have a consistent stance backed by a linter. The ~80 character lines look nice, but lead to strange diffs when the text is edited, so I'd advocate for line breaks at the sentence or paragraph level.

Thank you for cleaning these up. Last time I looked (to use in SLSA slsa-framework/slsa#75) I couldn't find a linter which supports semantic line breaks. That was long enough ago that it would be worth another look. Let's file a separate issue for this?

@joshuagl
Copy link
Member

joshuagl commented Jan 5, 2023

LGTM, thanks!

I added a commit that cleans this up a bit for this TAP. In the long term it'd be nice to have a consistent stance backed by a linter. The ~80 character lines look nice, but lead to strange diffs when the text is edited, so I'd advocate for line breaks at the sentence or paragraph level.

Thank you for cleaning these up. Last time I looked (to use in SLSA slsa-framework/slsa#75) I couldn't find a linter which supports semantic line breaks. That was long enough ago that it would be worth another look. Let's file a separate issue for this?

Filed #164

@mnm678
Copy link
Contributor Author

mnm678 commented Jan 5, 2023

@JustinCappos can you re-approve so this can be merged?

@JustinCappos JustinCappos merged commit 13d9f81 into theupdateframework:master Jan 6, 2023
@mnm678 mnm678 deleted the tap8-clarifications branch March 1, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants