canonical / rockcraft

Tool to create OCI Images using the language from Snapcraft and Charmcraft.
GNU General Public License v3.0
37 stars 44 forks source link

ROCK and chisselled ROCK tutorials have distracting diff #650

Open cpaelzer opened 3 months ago

cpaelzer commented 3 months ago

Request type

Fix

What needs to get done

Hi, the niceness on ROCKs and chiselling is that, as chisel slices already exist, they are as easy to use as parts already are.

The problem is that I'd consider it likely that users will do both tutorials after each other and they will wonder why there is so much difference.

diff -Naur hello/rockcraft.yaml chiselled-hello/rockcraft.yaml
--- hello/rockcraft.yaml    2024-07-24 11:58:58.630846588 +0200
+++ chiselled-hello/rockcraft.yaml  2024-07-24 11:57:55.547364572 +0200
@@ -1,20 +1,16 @@
-# Metadata section
-
-name: hello
-summary: Hello World
-description: The most basic example of a rock.
-version: "latest"
+name: chiselled-hello
+summary: Hello world from Chisel slices
+description: A "bare" rock containing the "hello" package binaries from Chisel slices.
 license: Apache-2.0

+version: "latest"
 base: bare
-build-base: ubuntu@22.04
+build_base: "ubuntu@22.04"
 platforms:
-  amd64:  # Make sure this value matches your computer's architecture
-
-# Parts section
+  amd64:

 parts:
   hello:
     plugin: nil
     stage-packages:
-      - hello
+      - hello_bins

If I'm not mistaken only the last hunk is the real change. Aligning those to really be just different there would help to see how easy it is to use (existing) slices.

Documentation location

No response

Additional information

No response

cjdcordeiro commented 3 months ago

Yep, this is a valid point. @clay-lake we should take this into the batch of planned improvements