MIR reporter’s template¶
This section is a guideline for the reporter as they are filing an MIR bug. The intent is to:
Make the future owning team think about common issues
Provide the detail needed by the reviewer to decide: Can this package be well maintained in
main?
Usage follows How to use MIR templates.
1[Availability]
2TODO: The package TBDSRC is already in Ubuntu universe.
3TODO: The package TBDSRC build for the architectures it is designed to work on.
4TODO: It currently builds and works for architectures: TBD
5TODO: Link to package https://launchpad.net/ubuntu/+source/TBDSRC
6
7[Rationale]
8RULE: There must be a certain level of demand for the package
9TODO: - The package TBDSRC is required in Ubuntu main for TBD
10TODO-A: - The package TBDSRC will generally be useful for a large part of
11TODO-A: our user base
12TODO-B: - The package TBDSRC will not generally be useful for a large part of
13TODO-B: our user base, but is important/helpful still because TBD
14TODO: - Additional reasons TBD
15TODO: - Additionally new use-cases enabled by this are TBD
16TODO: - Package TBDSRC covers the same use case as TBD, but is better
17TODO: because TBD, thereby we want to replace it.
18TODO: - The package TBDSRC is a new runtime dependency of package TBD that
19TODO: we already support
20RULE: Sometimes there are other/better ways, often are achieved by using a
21RULE: library with similar functionality that is more commonly used and
22RULE: thereby already in main or a better candidate to promote.
23RULE: Reducing the set of supported software in Ubuntu helps to focus on the
24RULE: right things, otherwise Ubuntu developers will be consumed by updating
25RULE: many variations of the same - wasting valuable time that could be better
26RULE: spent elsewhere.
27RULE: If there are other packages in the archive that are close, but unable to
28RULE: address the problem you might spend some time explaining what exists and
29RULE: why it isn't a sufficient alternative.
30TODO: - There is no other/better way to solve this that is already in main or
31TODO: should go universe->main instead of this.
32RULE: If the package is in main in other releases (use rmadison to check),
33RULE: and the existing MIR and package content is still applicable and not
34RULE: outdated relative to what you want to add, then please help us to
35RULE: keep the discussion, argument and audit trail together.
36RULE: To do so just add a new per-release tasks instead of creating a new MIR.
37RULE: Otherwise - if the existing former case was way too different, continue
38RULE: preparing this new MIR and please reference to the previous MIR.
39RULE: This suggestion of per release tasks is valid in both directions.
40RULE: For example forward when something was MIRed in 24.10 and 25.04 but got
41RULE: demoted in 25.10 - and shall come back to 26.04 please add a task to
42RULE: the existing MIR instead of creating a new one. Of course the reasons for
43RULE: demotion in 25.10 will be important for this case.
44RULE: And for example backwards, when something was MIRed for 24.04 onward,
45RULE: but later is also needed in older releases like 22.04. In that
46RULE: case you likely want to ensure via SRUs that things are up to date anyway
47RULE: and yet again - if the content, reasoning and outside factors are not
48RULE: vastly different - you'd be expected to add per-release-tasks to the
49RULE: existing MIR case which makes it easier for reporter and reviewer alike.
50TODO-A: - This is the first time package will be in main
51TODO-B: - Package was in main before (Ubuntu aa.bb->xx.yy) (MIR-Bug LP: #...)
52RULE: You truly need to understand the difference between main and universe
53RULE: in general and in the context of changed rules (build-depends) and
54RULE: constraints (Ubuntu Pro made it less of a difference in many cases).
55RULE: We have seen requests that were mostly based on old "I said supported (a
56RULE: weakly defined term to begin with) in a contract, so it has to be in main"
57RULE: feelings, but with sometimes no true reason - neither technically nor
58RULE: helping the user base of Ubuntu. Hence we need to ask for that clearly.
59TODO: - The binary packages TBD needs to be in main to achieve TBD
60TODO-A: - All other binary packages built by TBDSRC should remain in universe
61TODO-B: - All binary packages built by TBDSRC need to be in main to achieve TBD
62
63RULE: Reviews will take some time. Also the potential extra work out of review
64RULE: feedback from either MIR-team and/or security-team will take time.
65RULE: For better prioritization it is quite helpful to clearly state the
66RULE: target release and set a milestone to the bug task.
67RULE: When doing so do not describe what you "wish" or "would like to have".
68RULE: Only milestones that are sufficiently well-founded and related to
69RULE: major releases will be considered
70TODO-A: - The package TBDSRC is required in Ubuntu main no later than TBD
71TODO-A: due to TBD
72TODO-B: - It would be great and useful to community/processes to have the
73TODO-B: package TBD in Ubuntu main, but there is no definitive deadline.
74
75[Security]
76RULE: The security history and the current state of security issues in the
77RULE: package must allow us to support the package for at least 9 months (120
78RULE: for LTS+ESM support) without exposing its users to an inappropriate level
79RULE: of security risks. This requires checking of several things:
80RULE: - Search in the National Vulnerability Database using the PKG as keyword
81RULE: https://cve.mitre.org/cve/search_cve_list.html
82RULE: - check OSS security mailing list (feed into search engine
83RULE: 'site:www.openwall.com/lists/oss-security <pkgname>')
84RULE: - Ubuntu CVE Tracker
85RULE: https://ubuntu.com/security/cve?package=<source-package-name>
86RULE: - Debian Security Tracker
87RULE: https://security-tracker.debian.org/tracker/source-package/<source-package-name>
88TODO-A: - Had #TBD security issues in the past
89TODO-A: - TBD links to such security issues in trackers
90TODO-A: - TBD to any context that shows how these issues got handled in
91TODO-A: the past
92TODO-B: - No CVEs/security issues in this software in the past
93
94RULE: - Check for security relevant binaries, services and behavior.
95RULE: If any are present, this requires a more in-depth security review.
96RULE: Demonstrating that common isolation/risk-mitigation patterns are used
97RULE: will help to raise confidence. For example a service running as root
98RULE: open to the network will need to be considered very carefully. The same
99RULE: service dropping the root permissions after initial initialization,
100RULE: using various systemd isolation features and having a default active
101RULE: apparmor profile is much less concerning and can speed up acceptance.
102RULE: This helps Ubuntu, but you are encouraged to consider working with
103RULE: Debian and upstream to get those security features used at wide scale.
104RULE: - It might be impossible for the submitting team to check this perfectly
105RULE: (the security team will), but you should be aware that deprecated
106RULE: security algorithms like 3DES or TLS/SSL 1.1 are not acceptable.
107RULE: If you think a package might do that it would be great to provide a
108RULE: hint for the security team like "Package may use deprecated crypto"
109RULE: and provide the details you have about that.
110TODO: - no `suid` or `sgid` binaries
111TODO-A: - no executables in `/sbin` and `/usr/sbin`
112TODO-B: - Binary TBD in sbin is no problem because TBD
113TODO-A: - Package does not install services, timers or recurring jobs
114TODO-B: - Package does install services, timers or recurring jobs
115TODO-B: TBD (list services, timers, jobs)
116TODO: - Security has been kept in mind and common isolation/risk-mitigation
117TODO: patterns are in place utilizing the following features:
118TODO: TBD (add details and links/examples about things like dropping
119TODO: permissions, using temporary environments, restricted users/groups,
120TODO: seccomp, systemd isolation features, apparmor, ...)
121TODO-A: - Packages does not open privileged ports (ports < 1024).
122TODO-B: - Packages open privileged ports (ports < 1024), but they have
123TODO-B: a reason to do so (TBD)
124TODO-A: - Package does not expose any external endpoints
125TODO-B: - Package does expose an external endpoint, it is
126TODO-B: TBD endpoint + TBD purpose
127TODO: - Packages does not contain extensions to security-sensitive software
128TODO: (filters, scanners, plugins, UI skins, ...)
129
130RULE: The package should not use deprecated security algorithms like 3DES or
131RULE: TLS/SSL 1.1. The security team is the one responsible to check this,
132RULE: but if you happen to spot something it helps to provide a hint.
133RULE: Provide whatever made you suspicious as details along that statement.
134RULE: Or remove the following lines entirely if you did not spot anything.
135TODO: - I've spotted what I consider deprecated algorithms, the security team
136TODO: should have a more careful look please, details are:
137
138[Quality assurance - function/usage]
139RULE: - After installing the package it must be possible to make it working with
140RULE: a reasonable effort of configuration and documentation reading.
141TODO-A: - The package works well right after install
142TODO-B: - The package needs post install configuration or reading of
143TODO-B: documentation, there isn't a safe default because TBD
144
145[Quality assurance - maintenance]
146RULE: - To support a package, we must be reasonably convinced that upstream
147RULE: supports and cares for the package.
148RULE: - The status of important bugs in Debian, Ubuntu and upstream's bug
149RULE: tracking systems must be evaluated. Important bugs must be pointed out
150RULE: and discussed in the MIR report.
151TODO: - The package is maintained well in Debian/Ubuntu/Upstream and does
152TODO: not have too many, long-term & critical, open bugs
153TODO: - Ubuntu https://bugs.launchpad.net/ubuntu/+source/TBDSRC/+bug
154TODO: - Debian https://bugs.debian.org/cgi-bin/pkgreport.cgi?src=TBDSRC
155TODO: - Upstream's bug tracker, e.g., GitHub Issues
156TODO: - The package has important open bugs, listing them: TBD
157TODO-A: - The package does not deal with exotic hardware we cannot support
158TODO-B: - The package does deal with exotic hardware, such hardware is available
159TODO-B: to the team for debugging, test, verification and development via:
160RULE: This is about confidence to be able to maintain the package, therefore
161RULE: any option (the examples or anything else you add) is "valid", but it
162RULE: depends on the case if that is then considered sufficient.
163RULE: The following examples are in descending order in regard to how "ok" they
164RULE: likely will be.
165TODO-B1: - testflinger under the following queue(s): TBD
166TODO-B2: - (multiple) Canonical systems in the TBD computing center/lab
167TODO-B3: - an engineering sample in engineers home on TBD team, manager TBD
168TODO-B4: - (multiple) cloud providers as type: TBD
169TODO-B5: - hopefully somewhen getting it due to TBD
170
171[Quality assurance - testing]
172RULE: - The package must include a non-trivial test suite
173RULE: - it should run at package build and fail the build if broken
174TODO-A: - The package runs a test suite on build time, if it fails
175TODO-A: it makes the build fail, link to build log TBD
176TODO-B: - The package does not run a test at build time because TBD
177
178RULE: - The package should, but is not required to, also contain
179RULE: non-trivial autopkgtest(s).
180TODO-A: - The package runs an autopkgtest, and is currently passing on
181TODO-A: this TBD list of architectures, link to test logs TBD
182TODO-B: - The package does not run an autopkgtest because TBD
183
184RULE: - existing but failing tests that shall be handled as "ok to fail"
185RULE: need to be explained along the test logs below
186TODO-A: - The package does have not failing autopkgtests right now
187TODO-B: - The package does have failing autopkgtests tests right now, but since
188TODO-B: they always failed they are handled as "ignored failure", this is
189TODO-B: ok because TBD
190
191RULE: - If no build tests nor autopkgtests are included, and/or if the package
192RULE: requires specific hardware to perform testing, the subscribed team
193RULE: must provide a written test plan in a comment to the MIR bug, and
194RULE: commit to running that test either at each upload of the package or
195RULE: at least once each release cycle. In the comment to the MIR bug,
196RULE: please link to the codebase of these tests (scripts or doc of manual
197RULE: steps) and attach a full log of these test runs. This is meant to
198RULE: assess their validity (e.g. not just superficial).
199RULE: If possible such things should stay in universe. Sometimes that is
200RULE: impossible due to the way how features/plugins/dependencies work
201RULE: but if you are going to ask for promotion of something untestable
202RULE: please outline why it couldn't provide its value (e.g. by splitting
203RULE: binaries) to users from universe.
204RULE: This is a balance that is hard to strike well, the request is that all
205RULE: options have been exploited before giving up. Look for more details
206RULE: and backgrounds https://github.com/canonical/ubuntu-mir/issues/30
207RULE: Just like in the SRU process it is worth to understand what the
208RULE: consequences a regression (due to a test miss) would be. Therefore
209RULE: if being untestable we ask to outline what consequences this would
210RULE: have for the given package. And let us be honest, even if you can
211RULE: test you are never sure you will be able to catch all potential
212RULE: regressions. So this is mostly to force self-awareness of the owning
213RULE: team than to make a decision on.
214TODO: - The package can not be well tested at build or autopkgtest time
215TODO: because TBD. To make up for that:
216TODO-A: - We have access to such hardware in the team
217TODO-B: - We have allocated budget to get this hardware, but it is not here
218TODO-B: yet
219TODO-C: - We have checked with solutions-qa and will use their hardware
220TODO-C: through testflinger
221TODO-D: - We have checked with other team TBD and will use their hardware
222TODO-D: through TBD (eg. MAAS)
223TODO-E: - We have checked and found a simulator which covers this case
224TODO-E: sufficiently for testing, our plan to use it is TBD
225TODO-F: - We have engaged with the upstream community and due to that
226TODO-F: can tests new package builds via TBD
227TODO-G: - We have engaged with our user community and due to that
228TODO-G: can tests new package builds via TBD
229TODO-H: - We have engaged with the hardware manufacturer and made an
230TODO-H: agreement to test new builds via TBD
231TODO-A-H: - Based on that access outlined above, here are the details of the
232TODO-A-H: test plan/automation TBD (e.g. script or repo) and (if already
233TODO-A-H: possible) example output of a test run: TBD (logs).
234TODO-A-H: We will execute that test plan
235TODO-A-H1: on-uploads
236TODO-A-H2: regularly (TBD details like frequency: monthly, infra: jira-url)
237TODO-X: - We have exhausted all options, there really is no feasible way
238TODO-X: to test or recreate this. We are aware of the extra implications
239TODO-X: and duties this has for our team (= help SEG and security on
240TODO-X: servicing this package, but also more effort on any of your own
241TODO-X: bug triage and fixes).
242TODO-X: Due to TBD there also is no way to provide this to users from
243TODO-X: universe.
244TODO-X: Due to the nature, integration and use cases of the package the
245TODO-X: consequences of a regression that might slip through most likely
246TODO-X: would include
247TODO-X: - TBD
248TODO-X: - TBD
249TODO-X: - TBD
250
251RULE: - In some cases a solution that is about to be promoted consists of
252RULE: several very small libraries and one actual application uniting them
253RULE: to achieve something useful. This is rather common in the go/rust space.
254RULE: In that case often these micro-libs on their own can and should only
255RULE: provide low level unit-tests. But more complex autopkgtests make no
256RULE: sense on that level. Therefore in those cases one might want to test on
257RULE: the solution level.
258RULE: - Process wise MIR-requesting teams can ask (on the bug) for this
259RULE: special case to apply for a given case, which reduces the test
260RULE: constraints on the micro libraries but in return increases the
261RULE: requirements for the test of the actual app/solution.
262RULE: - Since this might promote micro-lib packages to main with less than
263RULE: the common level of QA any further MIRed program using them will have
264RULE: to provide the same amount of increased testing.
265TODO: - This package is minimal and will be tested in a more wide reaching
266TODO: solution context TBD, details about this testing are here TBD
267
268[Quality assurance - packaging]
269RULE: - The package uses a debian/watch or debian/upstream/metadata file
270RULE: whenever possible. The second option is the alternative for packages
271RULE: maintained with git-buildpackage. Consider whether that's
272RULE: still true at the time of reporting your MIR. In cases where this is
273RULE: not possible (e.g. native packages), the package should either provide
274RULE: a debian/README.source file or a debian/watch file (with comments only)
275RULE: providing clear instructions on how to generate the source tar file.
276RULE: For clarity the TODOs below refer as "upstream watch file" to any
277RULE: solution similar to the alternatives above which must be present in the
278RULE: package so tools can detect and fetch new upstream releases.
279TODO-A: - A mechanism to detect and fetch new upstream versions is present and works
280TODO-B: - A mechanism to detect and fetch new upstream versions is not present,
281TODO-B: instead it has TBD
282TODO-C: - A mechanism to detect and fetch new upstream versions is not present
283TODO-C: because it is a native package
284
285RULE: - The package should define the correct "Maintainer:" field in
286RULE: debian/control. This needs to be updated, using `update-maintainer`
287RULE: whenever any Ubuntu delta is applied to the package, as suggested by
288RULE: dpkg (LP: #1951988)
289TODO: - debian/control defines a correct Maintainer field
290
291RULE: - It is often useful to run `lintian --pedantic` on the package to spot
292RULE: the most common packaging issues in advance
293RULE: - Non-obvious or non-properly commented lintian overrides should be
294RULE: explained
295TODO: - This package does not yield massive lintian Warnings, Errors
296TODO: - Please link to a recent build log of the package <TBD>
297TODO: - Please attach the full output you have got from
298TODO: `lintian --pedantic` as an extra post to this bug.
299TODO-A: - Lintian overrides are not present
300TODO-B: - Lintian overrides are present, but ok because TBD
301
302RULE: - The package should not rely on obsolete or about to be demoted packages.
303RULE: That currently includes package dependencies on Python2 (without
304RULE: providing Python3 packages), and packages depending on GTK2.
305TODO: - This package does not rely on obsolete or about to be demoted packages.
306TODO: - This package has no python2 or GTK2 dependencies
307
308RULE: - Debconf questions should not bother the default user too much
309TODO-A: - The package will be installed by default, but does not ask debconf
310TODO-A: questions higher than medium
311TODO-B: - The package will not be installed by default
312
313RULE: - The source packaging (in debian/) should be reasonably easy to
314RULE: understand and maintain.
315TODO-A: - Packaging and build is easy, link to debian/rules TBD
316TODO-B: - Packaging is complex, but that is ok because TBD
317
318[UI standards]
319TODO-A: - Application is not end-user facing (does not need translation)
320TODO-B: - Application is end-user facing, Translation is present, via standard
321TODO-B: intltool/gettext or similar build and runtime internationalization
322TODO-B: system see TBD
323
324TODO-A: - End-user applications that ships a standard conformant desktop file,
325TODO-A: see TBD
326TODO-B: - End-user applications without desktop file, not needed because TBD
327
328[Dependencies]
329RULE: - In case of alternatives, the first alternative must be in main.
330RULE: Depends: concrete-package-in-main | metapackage
331RULE: - Build(-only) dependencies can be in universe
332RULE: - If there are further dependencies they need a separate MIR discussion
333RULE: (this can be a separate bug or another task on the main MIR bug)
334TODO-A: - Used check-mir from ubuntu-dev-tools to validate
335TODO-A: all dependencies or recommends are in main.
336TODO-B: - There are further dependencies that are not yet in main, MIR for them
337TODO-B: is at TBD
338TODO-C: - There are further dependencies that are not yet in main, the MIR
339TODO-C: process for them is handled as part of this bug here.
340
341[Standards compliance]
342RULE: - Major violations should be documented and justified.
343RULE: - FHS: https://refspecs.linuxfoundation.org/fhs.shtml
344RULE: - Debian Policy: https://www.debian.org/doc/debian-policy/
345TODO-A: - This package correctly follows FHS and Debian Policy
346TODO-B: - This package violates FHS or Debian Policy, reasons for that are TBD
347
348[Maintenance/Owner]
349RULE: The package must have an acceptable level of maintenance corresponding
350RULE: to its complexity:
351RULE: - All packages must have a designated "owning" team, regardless of
352RULE: complexity. Only a selected set of Launchpad teams can own a package
353RULE: in main, you can find this list here:
354RULE: https://git.launchpad.net/ubuntu-archive-tools/tree/lputils.py#n46
355RULE: This requirement of an owning-team comes in two aspects:
356RULE: - A case needs to have a team essentially saying "yes we will own that"
357RULE: to enter the MIR process. Usually that is implied by team members
358RULE: filing MIR requests having the backup by their management for the
359RULE: long term commitment this implies.
360RULE: - A community driven MIR request might be filed to show the use case,
361RULE: but then, as a first step, needs to get a team agreeing to own
362RULE: it before the case can be processed further.
363RULE: If unsure which teams to consider have a look at the current mapping
364RULE: http://reqorts.qa.ubuntu.com/reports/m-r-package-team-mapping.html
365RULE: In that case (you are not a representative of the team who will
366RULE: gain the long term committment to this) please ask a representative
367RULE: of that team to comment on the bug acknowledging that they are ok to
368RULE: own it.
369RULE: - The package needs a bug subscriber before it can be promoted to main.
370RULE: Strictly speaking that subscription can therefore wait until the
371RULE: moment of the actual promotion by an archive admin. But it is
372RULE: strongly recommended to subscribe early, as the owning team will get
373RULE a preview of the to-be-expected incoming bugs later on.
374RULE: - Simple packages (e.g. language bindings, simple Perl modules, small
375RULE: command-line programs, etc.) might not need very much maintenance
376RULE: effort, and if they are maintained well in Debian we can just keep them
377RULE: synced. They still need a subscribing team to handle bugs, FTBFS and
378RULE: tests
379RULE: - More complex packages will usually need a developer or team of
380RULE: developers paying attention to their bugs, whether that be in Ubuntu
381RULE: or elsewhere (often Debian). Packages that deliver major new headline
382RULE: features in Ubuntu need to have commitment from Ubuntu developers
383RULE: willing to spend substantial time on them.
384TODO-A: - The owning team will be TBD and I have their acknowledgment for
385TODO-A: that commitment
386TODO-B: - I Suggest the owning team to be TBD
387TODO-A: - The future owning team is already subscribed to the package
388TODO-B: - The future owning team is not yet subscribed, but will subscribe to
389TODO-B: the package before promotion
390
391RULE: - Responsibilities implied by static builds promoted to main, which is
392RULE: not a recommended but a common case with golang and rust packages.
393RULE: - the security team will track CVEs for all vendored/embedded sources in main
394RULE: - the security team will provide updates to main for all `golang-*-dev`
395RULE: packages
396RULE: - the security team will provide updates to main for non-vendored
397RULE: dependencies as per normal procedures (including e.g.,
398RULE: sponsoring/coordinating uploads from teams/upstream projects, etc)
399RULE: - the security team will perform no-change-rebuilds for all packages
400RULE: listing an CVE-fixed package as Built-Using and coordinate testing
401RULE: with the owning teams responsible for the rebuilt packages
402RULE: - for packages that build using any `golang-*-dev` packages:
403RULE: - the owning team must state their commitment to test
404RULE: no-change-rebuilds triggered by a dependent library/compiler and to
405RULE: fix any issues found for the lifetime of the release (including ESM
406RULE: when included)
407RULE: - the owning team must provide timely testing of no-change-rebuilds
408RULE: from the security team, fixing the rebuilt package as necessary
409RULE: - for packages that build with approved vendored code:
410RULE: - the owning team must state their commitment to provide updates to
411RULE: the security team for any affected vendored code for the lifetime of
412RULE: the release (including ESM when included)
413RULE: - the security team will alert the owning team of issues that may
414RULE: affect their vendored code
415RULE: - the owning team will provide timely, high quality updates for the
416RULE: security team to sponsor to fix issues in the affected vendored code
417RULE: - the owning team will use a minimal set of vendored code (e.g., Rust
418RULE: packages are unlikely to need `*_win` crates to build)
419RULE: - if subsequent uploads add new vendored components or dependencies
420RULE: these have to be reviewed and agreed by the security team.
421RULE: - Such updates in the project might be trivial, but imply that a
422RULE: dependency for e.g. a CVE fix will be moved to a new major version.
423RULE: Being vendored that does gladly at least not imply incompatibility
424RULE: issues with other packages or the SRU policy. But it might happen
425RULE: that this triggers either:
426RULE: a) The need to adapt the current version of the main package and/or
427RULE: other vendored dependencies to work with the new dependency
428RULE: b) The need to backport the fix in the dependency as the main
429RULE: package will functionally only work well with the older version
430RULE: c) The need to backport the fix in the dependency, as it would imply
431RULE: requiring a newer toolchain to be buildable that isn't available
432RULE: in the target release.
433RULE: - The rust ecosystem currently isn't yet considered stable enough for
434RULE: classic lib dependencies and transitions in main; therefore the
435RULE: expectation for those packages is to vendor (and own/test) all
436RULE: dependencies (except those provided by the rust runtime itself).
437RULE: This implies that all the rules for vendored builds always
438RULE: apply to them. In addition:
439RULE: - The rules and checks for rust based packages are preliminary and might
440RULE: change over time as the ecosystem matures and while
441RULE: processing the first few rust based packages.
442RULE: - It is expected rust builds will use dh-cargo so that a later switch
443RULE: to non vendored dependencies isn't too complex (e.g. it is likely
444RULE: that over time more common libs shall become stable and then archive
445RULE: packages will be used to build).
446RULE: - The tooling to get a Cargo.lock that will include internal vendored
447RULE: dependencies is described at:
448RULE: https://github.com/ubuntu/ubuntu-project-docs/blob/main/docs/MIR/mir-rust.md
449RULE: - An example of how Rust dependency vendoring can be automated is
450RULE: "s390-tools", isolating crates in a .orig-vendor.tar.xz tarball:
451RULE: * https://git.launchpad.net/ubuntu/+source/s390-tools/tree/debian/rules
452RULE: Other examples include "authd" (for a native package, combined with
453RULE: Golang vendoring) and "gnome-snapshot" (using debian/missing-sources):
454RULE: * authd:
455RULE: https://github.com/ubuntu/authd/blob/main/debian/rules
456RULE: * gnome-snapshot:
457RULE: https://salsa.debian.org/ubuntu-dev-team/snapshot/-/blob/ubuntu/latest/debian/README.source
458
459RULE: - All vendored dependencies (no matter what language) shall have a
460RULE: way to be refreshed
461TODO-A: - This does not use static builds
462TODO-B: - The team TBD is aware of the implications by a static build and
463TODO-B: commits to test no-change-rebuilds and to fix any issues found for the
464TODO-B: lifetime of the release (including ESM)
465
466TODO-A: - This does not use vendored code
467TODO-B: - The team TBD is aware of the implications of vendored code and (as
468TODO-B: alerted by the security team) commits to provide updates and backports
469TODO-B: to the security team for any affected vendored code for the lifetime
470TODO-B: of the release (including ESM).
471
472TODO-A: - This does not use vendored code
473TODO-B: - This package uses vendored go code tracked in go.sum as shipped in the
474TODO-B: package, refreshing that code is outlined in debian/README.source
475TODO-C: - This package uses vendored rust code tracked in Cargo.lock as shipped,
476TODO-C: in the package (at /usr/share/doc/<pkgname>/Cargo.lock - might be
477TODO-C: compressed), refreshing that code is outlined in debian/README.source
478TODO-D: - This package uses vendored code, refreshing that code is outlined
479TODO-D: in debian/README.source
480
481TODO-A: - This does not use vendored code
482TODO-B: - This package uses vendored code, the debian/copyright has been
483TODO-B: updated to cover the vendored content
484
485TODO-A: - This package is not rust based
486TODO-B: - This package is rust based and vendors all non language-runtime
487TODO-B: dependencies
488
489RULE: - Some packages build and update often, in this case everyone can just
490RULE: check the recent build logs to ensure if it builds fine.
491RULE: But some other packages are rather stable and have not been rebuilt
492RULE: in a long time. There no one can be confident it would build on e.g.
493RULE: an urgent security fix. Hence we ask if there has been a recent build.
494RULE: That might be a recent build that has been done anyway as seen on
495RULE: https://launchpad.net/ubuntu/+source/<source>, a reference to a recent
496RULE: archive test rebuild (those are announced on the ubuntu-devel mailing
497RULE: list like https://lists.ubuntu.com/archives/ubuntu-devel-announce/2024-January/001342.html),
498RULE: or a build set up by the reporter in a PPA with all architectures
499RULE: enabled.
500TODO-A: - The package has been built within the last 3 months in the archive
501TODO-B: - The package has been built within the last 3 months as part
502TODO-B: of a test rebuild
503TODO-C: - The package has been built within the last 3 months in PPA
504TODO-D: - The package has been built within the last 3 months in sbuild as it
505TODO-D: can not be uploaded yet
506RULE: - To make it easier for everyone, please provide a link to that build so
507RULE: everyone can follow up easily e.g. checking the various architectures.
508RULE: Example https://launchpad.net/ubuntu/+source/qemu/1:8.2.2+ds-0ubuntu1
509TODO: - Build link on launchpad: TBD
510
511RULE: A few times we had packages that seemed fine for the package itself, but
512RULE: caused quite some fallout and effort in related teams. We'd ask you to
513RULE: think who else might be affected by promoting this package(s) and to
514RULE: please coordinate with them upfront so they have time, understanding and
515RULE: sympathy available.
516RULE: Examples of the past which we admit could have been better (grows by
517RULE: painful lessons learned):
518RULE: - changing to rust coreutils forced us to update any apparmor profiles
519RULE that referred to these paths
520TODO-A: This change will not impact other teams
521TODO-B: This change will impact other teams TBD[, TBD] and they are
522TODO-B: aware due to TBD
523
524[Background information]
525RULE: - The package descriptions should explain the general purpose and context
526RULE: of the package. Additional explanations/justifications should be done in
527RULE: the MIR report.
528RULE: - If the package was renamed recently, or has a different upstream name,
529RULE: this needs to be explained in the MIR report.
530TODO: The Package description explains the package well
531TODO: Upstream Name is TBD
532TODO: Link to upstream project TBD
533TODO: TBD (any further background that might be helpful