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, howto, and reference for components #4904

Merged
merged 3 commits into from
Jul 12, 2024
Merged

docs: add explanation, howto, and reference for components #4904

merged 3 commits into from
Jul 12, 2024

Conversation

mr-cal
Copy link
Collaborator

@mr-cal mr-cal commented Jul 10, 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)

Add explanation, how-to, and reference for components.

Fixes #4857
(CRAFT-3028)

@mr-cal mr-cal marked this pull request as draft July 10, 2024 12:57
@mr-cal mr-cal changed the title [DRAFT] docs: include partition documentation from craft-parts docs: add explanation, howto, and reference for components Jul 11, 2024
@mr-cal mr-cal force-pushed the work/CRAFT-3028/components-documentation branch from c29c04f to 54210cc Compare July 11, 2024 20:33
@mr-cal mr-cal marked this pull request as ready for review July 11, 2024 20:33
tigarmo
tigarmo approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@tigarmo tigarmo left a comment

Choose a reason for hiding this comment

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

nice docs! Left some corrections and one note that you can chew on over the weekend ;)

docs/explanation/components.rst Outdated Show resolved Hide resolved
docs/explanation/components.rst Outdated Show resolved Hide resolved
docs/explanation/components.rst Outdated Show resolved Hide resolved
docs/explanation/components.rst Outdated Show resolved Hide resolved
docs/explanation/components.rst Outdated Show resolved Hide resolved
docs/howto/components.rst Show resolved Hide resolved
docs/reference/components.rst Outdated Show resolved Hide resolved
@mr-cal
docs: feedback from pr
b1395fd 
Signed-off-by: Callahan Kovacs <[email protected]>
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.

Love it, looking forward to this going live so I can link to it from the craft-parts and craft-application partitions docs.

docs/explanation/components.rst Outdated Show resolved Hide resolved
docs/explanation/components.rst Show resolved Hide resolved
docs/howto/components.rst Show resolved Hide resolved
@mr-cal
docs: feedback from PR
72f3cbd 
Signed-off-by: Callahan Kovacs <[email protected]>
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.

Sweet

@mr-cal
Copy link
Collaborator Author

mr-cal commented Jul 12, 2024

Spread tests failures unrelated, see #4910

@mr-cal mr-cal merged commit 011dd11 into main Jul 12, 2024
6 of 10 checks passed
@mr-cal mr-cal deleted the work/CRAFT-3028/components-documentation branch July 12, 2024 21:15
farshidtz pushed a commit to farshidtz/snapcraft that referenced this pull request Jul 18, 2024
@mr-cal @farshidtz
docs: add explanation, how-to, and reference for components (canonica…
f2e94be 
…l#4904)

Signed-off-by: Callahan Kovacs <[email protected]>
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 <[email protected]>
Date:   Wed Jul 17 10:57:51 2024 -0500

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

    Signed-off-by: Callahan Kovacs <[email protected]>

commit fa1043d
Author: Callahan <[email protected]>
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 <[email protected]>

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] <[email protected]>
    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] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Callahan <[email protected]>

commit 91fa63c
Author: Callahan <[email protected]>
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 <[email protected]>

commit 011dd11
Author: Callahan <[email protected]>
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 <[email protected]>

commit f313611
Author: Sergio Schvezov <[email protected]>
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 <[email protected]>
Date:   Wed Jul 10 15:03:33 2024 -0300

    ci: use native Ubuntu python for tests

    Signed-off-by: Sergio Schvezov <[email protected]>

commit fb1834c
Author: Scarlett Gately Moore <[email protected]>
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 <[email protected]>
Date:   Wed Jul 10 14:01:53 2024 -0300

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

commit 74b7b75
Author: Sergio Schvezov <[email protected]>
Date:   Wed Jul 10 09:28:36 2024 -0300

    ci: set the branchdir for TICS

commit 0668b6c
Author: Sergio Schvezov <[email protected]>
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] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit 1d17810
Author: Callahan <[email protected]>
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 <[email protected]>

commit d9c8781
Author: Callahan <[email protected]>
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 <[email protected]>

commit 124c932
Author: Callahan Kovacs <[email protected]>
Date:   Tue Jul 2 15:48:31 2024 -0500

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

    Signed-off-by: Callahan Kovacs <[email protected]>

commit 3325af0
Author: Callahan Kovacs <[email protected]>
Date:   Wed Jul 3 13:30:06 2024 -0500

    feat(remotebuild): allow build-for all

    Signed-off-by: Callahan Kovacs <[email protected]>

commit c1c70a2
Author: Callahan Kovacs <[email protected]>
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 <[email protected]>

commit 4bb948b
Author: Callahan Kovacs <[email protected]>
Date:   Tue Jul 2 12:41:40 2024 -0500

    build(deps): bump craft libraries

commit fad8df3
Author: সৌম্যদীপ ঘোষ <[email protected]>
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

@mattculler mattculler mattculler approved these changes

@tigarmo tigarmo tigarmo approved these changes

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

Successfully merging this pull request may close these issues.

Write components documentation
3 participants
@mr-cal @tigarmo @mattculler