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.

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

Update link to Pebble layer specification #779

Merged
merged 5 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
linkcheck_ignore = [
"http://0.0.0.0:8080",
"https://github.com/canonical/craft-actions#rockcraft-pack",
"https://github.com/canonical/pebble#layer-specification",
"https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/",
"https://juju.is/cloud-native-kubernetes-usage-report-2021#selection-criteria-for-container-images",
"https://matrix.to/#/#rocks:ubuntu.com",
# Ignore changelog links to Rockcraft releases, because the changelog entries
Expand Down
2 changes: 1 addition & 1 deletion docs/explanation/pebble.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ convert a Docker entrypoint to a Pebble layer.
.. _tini: https://github.com/krallin/tini
.. _s6-overlay: https://github.com/just-containers/s6-overlay
.. _imperative wrapper scripts (as suggested in the Docker documentation): https://docs.docker.com/engine/containers/multi-service_container/#use-a-wrapper-script
.. _Pebble layer specification: https://github.com/canonical/pebble#layer-specification
.. _Pebble layer specification: https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
3 changes: 2 additions & 1 deletion docs/how-to/rocks/convert-to-pebble-layer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Design the Pebble services
--------------------------

A `Pebble layer
<https://github.com/canonical/pebble#layer-specification>`_
<https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/
layer-specification/>`_
is composed of metadata, checks and services. The latter is present in
``rockcraft.yaml`` as a `top-level field
<https://canonical-rockcraft.readthedocs-hosted.com/en/latest/reference/
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rockcraft.yaml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -274,4 +274,4 @@ Example
:language: yaml


.. _`Pebble Layer Specification format`: https://github.com/canonical/pebble#layer-specification
.. _`Pebble Layer Specification format`: https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
4 changes: 2 additions & 2 deletions rockcraft/pebble.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class Check(CraftBaseModel):
"""Lightweight schema validation for a Pebble checks.
Based on
https://github.com/canonical/pebble#layer-specification
https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
tigarmo marked this conversation as resolved.
Show resolved Hide resolved
"""

override: Literal["merge", "replace"]
Expand Down Expand Up @@ -98,7 +98,7 @@ class Service(CraftBaseModel):
"""Lightweight schema validation for a Pebble service.
Based on
https://github.com/canonical/pebble#layer-specification
https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
"""

override: Literal["merge", "replace"]
Expand Down
4 changes: 2 additions & 2 deletions schema/rockcraft.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"$defs": {
"Check": {
"additionalProperties": false,
"description": "Lightweight schema validation for a Pebble checks.\n\nBased on\nhttps://github.com/canonical/pebble#layer-specification",
"description": "Lightweight schema validation for a Pebble checks.\n\nBased on\nhttps://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/",
"properties": {
"override": {
"enum": [
Expand Down Expand Up @@ -286,7 +286,7 @@
},
"Service": {
"additionalProperties": false,
"description": "Lightweight schema validation for a Pebble service.\n\nBased on\nhttps://github.com/canonical/pebble#layer-specification",
"description": "Lightweight schema validation for a Pebble service.\n\nBased on\nhttps://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/",
"properties": {
"override": {
"enum": [
Expand Down
Loading