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

rm: factory: Add info on TUF targets expiration configuration #687

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

mike-sul
Copy link
Contributor

@mike-sul mike-sul commented Feb 8, 2024

It turned the current info on the TUF targets expiration configuration is not quite accurate. It suggests to use <build-type>.params.TUF_TARGETS_EXPIRE parameters which is rather an internal mechanism and should not be recommended for users.

The proper way to set targets metadata default validity period is through the tuf.targets_expire_after parameter, this is the one that we should recommend to users.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@doanac
Copy link
Member

doanac commented Feb 8, 2024

@doanac
Copy link
Member

doanac commented Feb 8, 2024

@mike-sul mike-sul marked this pull request as ready for review February 8, 2024 15:20
@doanac
Copy link
Member

doanac commented Feb 8, 2024

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

Just one minor style suggestion, otherwise it lgtm.

Comment on lines 51 to 52
tuf
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
tuf
---
``tuf``
-------

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

It turned the current info on the TUF targets expiration
configuration is not quite accurate. It suggests to use
`<build-type>.params.TUF_TARGETS_EXPIRE` parameters which is rather an
internal mechanism and should not be recommended for users.

The proper way to set targets metadata default validity period is
through the `tuf.targets_expire_after` parameter, this is the one that
we should recommend to users.

Signed-off-by: Mike Sul <[email protected]>
@doanac
Copy link
Member

doanac commented Feb 8, 2024

@kprosise kprosise merged commit a38630d into main Feb 8, 2024
4 checks passed
@kprosise kprosise deleted the fix-tuf-targets-expiration branch March 5, 2024 13:10
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.

5 participants