Replace plainbox references (Infra) #1285
Conversation
|
/canonical/self-hosted-runners/run-workflows 9c8760f |
Hook25
left a comment
Hook25
left a comment
There was a problem hiding this comment.
I have to ask you just one change on this, please make all the checkbox -> Checkbox (I would do it myself but I can't push to your fork!)
Ty for this btw, really helps us out
|
Added a commit capitalizing all the references to Checkbox that I changed, and another that simply quotes "checkbox" where it's referencing the generic snap rather than the project specifically. |
|
/canonical/self-hosted-runners/run-workflows 3cb4e45 |
Hook25
left a comment
Hook25
left a comment
There was a problem hiding this comment.
Thank you very much for taking this up!
+1
|
In order to land this we need signed commits, can you please sign your commits? https://github.com/canonical/checkbox/blob/main/CONTRIBUTING.md#pull-requests |
Given there's inevitably still some references to plainbox left in the docs (mostly in identifiers), I think it makes sense to leave this definition here but to make clear the term is obsolete
This covers all the trivial replacements in the docs. Subsequent commits deal with the more complex cases
Given that the version referenced is 0.24, released in 2015, rather than try and map these to the checkbox versions they were first incorporated within I suspect it's better to simply remove the reference to plainbox entirely as the described behaviour is presumably present in every version of checkbox encountered today.
I can find no other references to plainbox-provider-snappy, and the units referenced in the examples below are now part of the "base" provider.
It doesn't appear to exist and just causes an error (tested with various base= options and none generated a cleanup.sh)
The checkbox-provider-myproject path *does* exist, but only under the checkbox-myproject path and there's no explicit instruction to enter it.
There doesn't appear to be an equivalent checkbox flag that the reference could be replaced with?
The man-pages do not exist (checkbox is distributed as a snap), and I suspect these references are better dealt with by linking to the reference docs
This is referring to an actual snap name, rather than the project itself.
waveform80
force-pushed
the
wot-no-plainbox
branch
from
3cb4e45 to
fc197c3
Compare
|
Should all be signed now (and verified after realizing the GPG key in GitHub hadn't been updated with new emails in forever) |
|
/canonical/self-hosted-runners/run-workflows fc197c3 |
2 participants
Description
Replaces references to plainbox with checkbox or, where sensible, simply removes them. This only affects files under
docs/but even then there are places where plainbox references remain, such as in category and job identifiers. However, I'm reasonably confident that all the changes proposed are within prose only.There are some references I've simply removed, because they reference specific plainbox versions and attempting to map these to checkbox versions is difficult and probably pointless (as they'll apply to all checkbox versions in current usage). There are also some "other" fixups, like a couple of obvious typos, a corrected path, and some fixed links.
The changes are organized into separate commits with the trivial obvious stuff first (where I'm confident that replacement of plainbox with checkbox is all that's needed), and the later commits covering stuff I'm a little less sure about which should probably be double-checked.
Each commit has additional commentary in the commit message. Where long paragraphs have been changed, I've re-wrapped things. If this makes things too hard to review, I'm happy to separate the re-wrap into a separate commit or just avoid the re-wrap entirely (and to rebase or re-work generally).
Resolved issues
Fixes: #1278
Tests
Tested build with sphinx locally; changes look reasonable and well formatted.