From 8f6e815f8439446b790774a0d7a3f4749b5d7549 Mon Sep 17 00:00:00 2001 From: Anatoli Babenia Date: Tue, 24 Sep 2024 21:20:56 +0300 Subject: [PATCH] docs: repo location, branch links and verbosity Fixes https://github.com/canonical/snapcraft-rocks/issues/53 --- README.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index dd05649..f12ddc7 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,7 @@ Snapcraft rocks =============== -This repository contains `Snapcraft`_ `rocks`_ and the sources to generate -them. The rocks are OCI-compliant container images that run different +`Snapcraft`_ `rocks`_ are OCI-compliant container images with different versions of Snapcraft to create snaps. Each rock in this repository bundles a specific version of Snapcraft, targeting @@ -16,6 +15,16 @@ following tags: - ``8_core24``, bundling the latest Snapcraft 8 capable of building ``core24`` snaps. +This repository contains sources for generating images. + +* `core22-7 `_ +* `core22-8 `_ +* `core24-7 `_ + +And repository of built container images. + +* https://github.com/canonical/snapcraft-rocks/pkgs/container/snapcraft + Usage ----- @@ -25,14 +34,18 @@ that you want to snap (the directory containing the ``snap`` folder with a ``snapcraft.yaml`` file), and this directory needs to be exposed to the running container as ``/project``. For example, the following command will mount the current directory into a new container and run ``pack`` on the -latest version of Snapcraft 7 for core22 snaps:: +latest version of Snapcraft 8 for core24 snaps:: - docker run -it -v `pwd`:/project ghcr.io/canonical/snapcraft:7_core22 pack + docker run -it -v `pwd`:/project ghcr.io/canonical/snapcraft:8_core24 pack Other commands, like ``clean`` or ``build``, can be called simply by replacing ``pack`` in the example above. Every argument provided after the image name is forwarded to Snapcraft. +To see `snapcraft` output, add flags:: + + docker run -it -v `pwd`:/project ghcr.io/canonical/snapcraft:8_core24 \; -v + Reporting bugs --------------