freedomofpress / freedomofpress/securedrop-dev-docs

release-process documentation is out of date

Open
#296 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
6
Forks
4
Avg merge
2h 22m
Merged PRs (30d)
1

Description

The "Release Process" section is out of date in a few ways, based on my experience in freedomofpress/securedrop#7790:

  • Building securedrop-admin via make build-debs-admin is not documented at all.
  • There are still references to Ubuntu Focal, whereas make build-debs now targets Noble and make build-debs-admin targets Tails's underlying Debian trixie.
  • While it is true that "-dbgsym packages belong in the main-debug component repo", this is handled automatically by tools/publish; it's not something that you have to make happen when you commit the packages themselves.
  • The "Build Metadata" page could be updated now that logs are saved automatically and can be committed directly.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked “Release Process” and “Build Metadata” pages, then compare them with the current build commands and publishing behavior described in the issue. Done means documenting securedrop-admin builds, updating the Ubuntu and Debian targets, clarifying automatic -dbgsym handling, and reflecting automatic log saving and direct commits.

Written by the indexing model from the issue text.

Assessment

Tech stack
debian, ubuntu
Domain
build-system, documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.