Overhaul CI documentation #183
Conversation
docs/continuous_integration.rst
Outdated
| For ``securedrop-workstation`` and ``securedrop-client``, we build packages on every merged | ||
| commit and every night and publish them to our test yum and apt repositories respectively. |
There was a problem hiding this comment.
Is it worth specifying when "every night" is? Not sure if that's the kind of detail worth putting in the docs or if people want to know they can go lookup the workflow.
There was a problem hiding this comment.
Yeah, I think if people want to know the exact time they can just look it up.
docs/testing_configuration_tests.rst
Outdated
| are some defaults set that you may want to change. You will need to export | ||
| ``GOOGLE_CREDENTIALS`` with authentication details for your GCP account, | ||
| which is outside the scope of this guide. Some parameters are specific to FPF's | ||
| GCE setup and may need adjusting if you are running elsewhere. |
There was a problem hiding this comment.
Is it worth enumerating these specific parameters so users can find where to start debugging if they run into problems?
There was a problem hiding this comment.
It's kind of a cop-out because I actually have no idea what it would take to run elsewhere. For example, we have a custom built Debian image we use (https://github.com/freedomofpress/securedrop/blob/dbdccc593e1aeab149dbd6019709394ec1e6dc9c/devops/gce-nested/gce-start.sh#L28) that I don't know what it would take to replicate.
legoktm
force-pushed
the
ci-improvements
branch
from
5dc8431 to
9a5387d
Compare
|
Thanks @enpaul for the detailed review! |
Broadly update the docs for: * switch to GitHub Actions * special branch prefixes in server repository * workstation and client nightlies * pointer to SDW CI * remove outdated information regarding server tests * simplify staging docs, not super practical to run outside our CI Refs #181.
|
(gonna rebase and resolve that index conflict realqk) |
Co-authored-by: Ethan Paul <[email protected]>
rocodes
force-pushed
the
ci-improvements
branch
from
9a5387d to
d9571e8
Compare
Status
Ready for review
Description of Changes
Broadly update the docs for:
Refs #181, #152.
I have intentionally not included any discussion of CD of docs and demo yet, I'll do that in a follow-up PR since this one was already getting pretty big.
Testing
Release
Checklist (Optional)
make docs-lint) passed locallymake docs-linkcheck) passedmake docs) docs at http://localhost:8000