-
Notifications
You must be signed in to change notification settings - Fork 9
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
Update README.md #400
Update README.md #400
Conversation
The changes so far are looking great! |
@gonzalo-bulnes - I spent some time separating release management from generic instructions on how to use this tool. So this PR should be reviewed in tandem with an incoming |
TODO: Once freedomofpress/securedrop-dev-docs#30 is merged, link to the section on how to build a dispVM rather than duplicating the instructions here, see https://github.com/freedomofpress/securedrop-dev-docs/pull/30/files#r1035458154 |
[Blocked on https://github.com/freedomofpress/infrastructure/pull/4068 + tandem PR for securedrop repos + actually renaming the repos] UPDATE: this is done |
b80a64e
to
1f5feba
Compare
@gonzalo-bulnes, if you end up merging freedomofpress/securedrop-dev-docs#30, this is the next PR to review, which references a section added in freedomofpress/securedrop-dev-docs#30 (see checklist in the PR description). |
[![CircleCI](https://circleci.com/gh/freedomofpress/securedrop-builder/tree/main.svg?style=svg)](https://circleci.com/gh/freedomofpress/securedrop-builder/tree/main) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is putting the badge above the main header intentional? (I notice it doesn't show up in the preview.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:/ I see it still when I "view file": https://github.com/freedomofpress/securedrop-builder/blob/1f5feba3f9176b17e16084bb7c0877dcd98560bc/README
The badge is intentionally there and this PR shouldn't remove it.
Only waiting for freedomofpress/securedrop-dev-docs#30 🙂 |
@creviera I see only Bookworm jobs are failing in CI, and FWIW I wouldn't block this PR on them. |
@gonzalo-bulnes, while addressing your reviews, I noticed another opportunity to further consolidate our documentation. For deployment, the readme now points to the docs in freedomofpress/securedrop-dev-docs#30, so you'll notice that last commit that I pushed is mostly just deleting stuff: ba2c611 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Only bookworm tests are failing (see Update apt LFS repo names #413 (comment))
- Consolidate and update workstation release management process securedrop-dev-docs#30 has been merged
- Link in the readme works (https://developers.securedrop.org/en/latest/workstation_release_management.html#how-to-create-the-dispvm-for-building-packages)
- visual inspection
Status
Closes #304
Description of Changes
securedrop-builder
name (I can't even remember it, it's so old ;))Checklist