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

Improve noble migration check script output #7369

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Conversation

legoktm
Copy link
Member

@legoktm legoktm commented Dec 9, 2024

Status

Ready for review

Description of Changes

  • Explicitly flag which messages are error conditions; otherwise it would be hard to tell whether "group is empty" or "group is not empty" is the problematic state.
  • Do the same for success messages by adding "OK" to them.
  • Add a newline before our closing help message.
  • Link to docs that explain how to resolve these issues (still pending review at Document how to resolve noble pre-migration issues securedrop-docs#612).

Testing

How should the reviewer test this PR?

Deployment

Any special considerations for deployment? n/a

Checklist

  • Linting (make lint) and tests (make test) pass in the development container

@legoktm legoktm added the noble Ubuntu Noble related work label Dec 9, 2024
@legoktm legoktm added this to the SecureDrop 2.11.0 milestone Dec 9, 2024
@legoktm legoktm requested a review from a team as a code owner December 9, 2024 19:50
@legoktm
Copy link
Member Author

legoktm commented Dec 9, 2024

While working on the documentation PR (freedomofpress/securedrop-docs#612), I realized the output wasn't that great, so these are some minor changes to improve it.

@cfm cfm self-assigned this Dec 10, 2024
cfm
cfm previously approved these changes Dec 10, 2024
Copy link
Member

@cfm cfm 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 good to me. Non-blocking nit: I would favor going all the way to (e.g.)—

  • ssh OK: group is empty
  • ssh ERROR: group is not empty [...]

—so that success as well as failure is explicit rather than implicit. But I defer to you.

@legoktm
Copy link
Member Author

legoktm commented Dec 10, 2024

That's a good idea, give me a minute :)

* Explicitly flag which messages are error conditions; otherwise it
  would be hard to tell whether "group is empty" or "group is not empty"
  is the problematic state.
* Do the same for success messages by adding "OK" to them.
* Add a newline before our closing help message.
* Link to docs that explain how to resolve these issues (still pending
  review at <freedomofpress/securedrop-docs#612>).
Copy link
Member

@cfm cfm left a comment

Choose a reason for hiding this comment

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

Lovely. Thanks, @legoktm.

@legoktm legoktm added this pull request to the merge queue Dec 10, 2024
Merged via the queue into develop with commit 435e978 Dec 10, 2024
44 checks passed
@legoktm legoktm deleted the imp-check-output branch December 10, 2024 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
noble Ubuntu Noble related work
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants