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

docs: repo location, branch links and verbosity #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
21 changes: 17 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 <https://github.com/canonical/snapcraft-rocks/tree/core22-7>`_
* `core22-8 <https://github.com/canonical/snapcraft-rocks/tree/core22-8>`_
* `core24-7 <https://github.com/canonical/snapcraft-rocks/tree/core24-8>`_

And repository of built container images.

* https://github.com/canonical/snapcraft-rocks/pkgs/container/snapcraft


Usage
-----
Expand All @@ -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
--------------
Expand Down