freedomofpress / freedomofpress/securedrop-https-everywhere-ruleset
Remove XML step when generating rulesets
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 4
- Avg merge
- 8m
- Merged PRs (30d)
- 7
Description
The current workflow is:
- pull data from the SD directory API (JSON format) plus onboarded.txt (CSV)
- manually write an XML file for each instance (committed)
- parse the XML and concatenate all of them into a JSON blob (gitignored)
- compress the JSON and sign it (committed)
I think it would be easier to just write JSON files and lose the XML indirection. It made sense when we were still using HTTPSE's tooling, but that's no longer the case. We should just commit a pretty-printed JSON blob (either one per instance, or just one giant-but-not-really for everything) and the compressed + signed versions. That would also probably fix issues like #92.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Trace the workflow from the SD directory API and onboarded.txt through XML generation, parsing, JSON assembly, compression, and signing. Resolve whether the committed output should use one JSON file per instance or one combined file, then verify that XML is no longer required and that the pretty-printed, compressed, and signed outputs are produced.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100