Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add explanation, reference, and how to for bases #4900

Merged
merged 9 commits into from
Jul 15, 2024
Merged

docs: add explanation, reference, and how to for bases #4900

merged 9 commits into from
Jul 15, 2024

Conversation

mr-cal
Copy link
Collaborator

@mr-cal mr-cal commented Jul 9, 2024 •
edited
Loading

  • Have you followed the guidelines for contributing?
  • Have you signed the CLA?
  • Have you successfully run tox run -m lint?
  • Have you successfully run tox run -e test-py310? (supported versions: py39, py310, py311, py312)

My task is to document how to use base and build-base for a kernel snap. This required laying groundwork:

(CRAFT-3083)

mr-cal added 2 commits July 8, 2024 10:52
@mr-cal
docs: import bases documentation from snapcraft.io/docs/base-snaps
831814b 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal
docs: add explanation, reference, and how to for bases
83f7d4a 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal force-pushed the work/CRAFT-3083/bases-documentation branch from e4680f9 to 83f7d4a Compare July 9, 2024 12:48
@mr-cal mr-cal requested review from cmatsuoka and mattculler July 9, 2024 13:18
mr-cal
mr-cal commented Jul 9, 2024
View reviewed changes
docs/reference/bases.rst Outdated Show resolved Hide resolved
cmatsuoka
cmatsuoka reviewed Jul 10, 2024
View reviewed changes
docs/explanation/bases.rst Show resolved Hide resolved
docs/explanation/bases.rst Show resolved Hide resolved
docs/explanation/bases.rst Outdated Show resolved Hide resolved
docs/explanation/bases.rst Show resolved Hide resolved
docs/explanation/bases.rst Outdated Show resolved Hide resolved
docs/howto/bases.rst Outdated Show resolved Hide resolved
docs/howto/bases.rst Show resolved Hide resolved
docs/reference/bases.rst Outdated Show resolved Hide resolved
@cmatsuoka
Copy link
Contributor

Looks good! Added some notes about adding more information about building snaps with a bare bases, and keeping support to existing kernel snap projects (at least until they're phased out) to allow rebuilding of existing snaps.

@mr-cal
chore: feedback from pr
9282256 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal added the squash label Jul 10, 2024
@mr-cal mr-cal requested a review from cmatsuoka July 10, 2024 19:53
@mr-cal
Copy link
Collaborator Author

mr-cal commented Jul 12, 2024

Updated to only document the current way to build kernel snaps.

cmatsuoka
cmatsuoka approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@cmatsuoka cmatsuoka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

mattculler
mattculler approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@mattculler mattculler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, that was very informative and I learned a lot!

It seems to me that a lot of this content would be applicable to more than just snapcraft - should some of this documentation be upstreamed to the docs for the relevant library/libraries?

docs/explanation/bases.rst Outdated Show resolved Hide resolved
docs/reference/bases.rst Outdated Show resolved Hide resolved
docs/howto/bases.rst Outdated Show resolved Hide resolved
@mr-cal
Copy link
Collaborator Author

mr-cal commented Jul 12, 2024

Excellent, that was very informative and I learned a lot!

It seems to me that a lot of this content would be applicable to more than just snapcraft - should some of this documentation be upstreamed to the docs for the relevant library/libraries?

That's a good point. I added some information in craft-application about bases and build-bases a few weeks ago. As a future improvement, that would be very useful to expand upon in craft-application and pull that into the applications.

On that note, I'm not sure if craft-application documentation is configured to be re-used in the application documentation.

@mattculler
Copy link
Contributor

Excellent, that was very informative and I learned a lot!
It seems to me that a lot of this content would be applicable to more than just snapcraft - should some of this documentation be upstreamed to the docs for the relevant library/libraries?

That's a good point. I added some information in craft-application about bases and build-bases a few weeks ago. As a future improvement, that would be very useful to expand upon in craft-application and pull that into the applications.

On that note, I'm not sure if craft-application documentation is configured to be re-used in the application documentation.

Well I do know that @lengau is using at least craft-parts docs in charmcraft, but maybe not craft-application. In any case, it's just a suggestion - if you think it might be feasible and useful then open a PR on the library repo, otherwise just ignore :)

@mr-cal
Copy link
Collaborator Author

mr-cal commented Jul 12, 2024

I did pull in some of your craft-parts documentation on partitions here.
I'll defer the craft-application documentation updates/inclusions since it's friday afternoon!

@mr-cal
docs: feedback from PR
ca1be2f 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal
Copy link
Collaborator Author

mr-cal commented Jul 12, 2024

Spread tests failures unrelated, see #4910

mattculler
mattculler approved these changes Jul 12, 2024
View reviewed changes
docs/explanation/bases.rst Outdated Show resolved Hide resolved
mr-cal added 2 commits July 12, 2024 15:01
@mr-cal
docs: feedback from PR
92c6da2 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal
chore(merge): 'main' into 'work/CRAFT-3083/bases-documentation'
617bc80
@mr-cal mr-cal merged commit 91fa63c into main Jul 15, 2024
6 of 10 checks passed
@mr-cal mr-cal deleted the work/CRAFT-3083/bases-documentation branch July 15, 2024 12:11
farshidtz pushed a commit to farshidtz/snapcraft that referenced this pull request Jul 18, 2024
@mr-cal @farshidtz
docs: add explanation, reference, and how to for bases (canonical#4900)
7834695 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
farshidtz added a commit to farshidtz/snapcraft that referenced this pull request Jul 18, 2024
@farshidtz
Squashed commit of the following:
f08d6e3 
commit d65754b
Author: Callahan Kovacs <callahan.kovacs@canonical.com>
Date:   Wed Jul 17 10:57:51 2024 -0500

    feat(extensions): pass app name to `get_app_snippet()`

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit fa1043d
Author: Callahan <callahan.kovacs@canonical.com>
Date:   Tue Jul 16 13:56:22 2024 -0500

    tests: disable `build-base: devel` spread tests (canonical#4922)

    Disable `build-base: devel` spread tests until we have the resources to
    debug the underlying issue with 24.10 buildd images and
    `systemd-resolved` (canonical#4921).

    We should be able to address this issue in 2024-Nov.

    Fixes canonical#4910
    (CRAFT-3105)

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit de7f1d5
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Jul 15 17:36:49 2024 -0500

    build(deps): bump zipp from 3.17.0 to 3.19.1 (canonical#4901)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit ccbc7b3
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Jul 15 14:27:32 2024 -0500

    build(deps): bump certifi from 2023.7.22 to 2024.7.4 in /docs/.sphinx (canonical#4903)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Callahan <callahan.kovacs@canonical.com>

commit 91fa63c
Author: Callahan <callahan.kovacs@canonical.com>
Date:   Mon Jul 15 07:11:41 2024 -0500

    docs: add explanation, reference, and how to for bases (canonical#4900)

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit 011dd11
Author: Callahan <callahan.kovacs@canonical.com>
Date:   Fri Jul 12 16:15:52 2024 -0500

    docs: add explanation, how-to, and reference for components (canonical#4904)

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit f313611
Author: Sergio Schvezov <sergio.schvezov@canonical.com>
Date:   Wed Jul 10 16:07:49 2024 -0300

    chore: add sorted flake8 and pylint for tiobe/tics

    Sorting proved useful in removing dups like pycodestyle

commit 6cbdff6
Author: Sergio Schvezov <sergio.schvezov@canonical.com>
Date:   Wed Jul 10 15:03:33 2024 -0300

    ci: use native Ubuntu python for tests

    Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com>

commit fb1834c
Author: Scarlett Gately Moore <sgmoore@debian.org>
Date:   Wed Jul 10 12:18:14 2024 -0700

    feat(extensions): add content interfaces for qt-common-themes to KDE Neon 6 (canonical#4884)

commit ccba428
Author: Sergio Schvezov <sergio.schvezov@canonical.com>
Date:   Wed Jul 10 14:01:53 2024 -0300

    ci: use correct attribute for tics workflow (canonical#4906)

commit 74b7b75
Author: Sergio Schvezov <sergio.schvezov@canonical.com>
Date:   Wed Jul 10 09:28:36 2024 -0300

    ci: set the branchdir for TICS

commit 0668b6c
Author: Sergio Schvezov <sergio.schvezov@canonical.com>
Date:   Mon Jul 8 16:55:44 2024 -0300

    fix: setup Python env for tiobe ci

    Also shallow checkout like the other workflows

commit a4e2895
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Jul 8 12:55:02 2024 -0500

    build(deps): bump certifi from 2023.11.17 to 2024.7.4 (canonical#4896)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit 1d17810
Author: Callahan <callahan.kovacs@canonical.com>
Date:   Mon Jul 8 08:37:34 2024 -0500

    build(deps): add 'validators' to install_requires (canonical#4898)

    `validators` was added in canonical#4888 to the requirement files but
    not to `setup.py`

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit d9c8781
Author: Callahan <callahan.kovacs@canonical.com>
Date:   Fri Jul 5 22:24:52 2024 -0500

    fix(remotebuild): require core20 snaps to use the legacy remote builder (canonical#4895)

    Requires core20 snaps to use the legacy remote builder because the new
    remote builder cannot parse core20 `snapcraft.yaml` files (canonical#4885).

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit 124c932
Author: Callahan Kovacs <callahan.kovacs@canonical.com>
Date:   Tue Jul 2 15:48:31 2024 -0500

    tests(remotebuild): add per-base remote-build spread tests

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit 3325af0
Author: Callahan Kovacs <callahan.kovacs@canonical.com>
Date:   Wed Jul 3 13:30:06 2024 -0500

    feat(remotebuild): allow build-for all

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit c1c70a2
Author: Callahan Kovacs <callahan.kovacs@canonical.com>
Date:   Tue Jul 2 14:37:49 2024 -0500

    fix(remotebuild): use legacy launchpad credentials if they exist

    If the legacy remote-build credentials exist and the new credentials do
    not, emit a deprecation warning and use the legacy credentials.

    Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

commit 4bb948b
Author: Callahan Kovacs <callahan.kovacs@canonical.com>
Date:   Tue Jul 2 12:41:40 2024 -0500

    build(deps): bump craft libraries

commit fad8df3
Author: সৌম্যদীপ ঘোষ <72045785+soumyaDghosh@users.noreply.github.com>
Date:   Sat Jul 6 00:46:47 2024 +0530

    fix: validate appstream metadata links and prefer links from project metadata (canonical#4888)

    - Validate that update_contact, donation, vcs-browser, bugtracker, and homepage
      fields adopted from an appstream metadata file are valid URLs or email addresses.
    - Contact, donation, source-code, issues, and website fields in a snapcraft.yaml take
      priority over appstream metadata

commit 4f3c19d
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Tue Jul 2 14:20:18 2024 -0400

    build(deps): bump urllib3 from 1.26.18 to 1.26.19 in /docs/.sphinx (canonical#4887)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sergiusens sergiusens sergiusens left review comments

@mattculler mattculler mattculler approved these changes

@cmatsuoka cmatsuoka cmatsuoka approved these changes

Assignees
No one assigned
Labels
squash
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mr-cal @cmatsuoka @mattculler @sergiusens