From 34d6f9a07b6480763d1178d0328dbd7a51e62c0d Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Thu, 23 May 2024 09:28:51 +0200 Subject: [PATCH] chore: fix rocks terminology --- .github/workflows/build.yaml | 6 +++--- .github/workflows/publish.yaml | 4 ++-- README.md | 17 ++++++++++------- rockcraft.yaml | 8 ++++---- 4 files changed, 19 insertions(+), 16 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index bfc9774..f3d01ee 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,4 +1,4 @@ -name: Build ROCK +name: Build rock concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -38,7 +38,7 @@ jobs: run: | sudo snap install yq sudo snap install rockcraft --classic --edge - - name: Build ROCK + - name: Build rock id: build run: | rockcraft pack --verbose @@ -46,7 +46,7 @@ jobs: VERSION=$(yq '.version' rockcraft.yaml) echo "rock=charmed-kafka_${VERSION}_amd64.rock" >> $GITHUB_OUTPUT - - name: Upload locally built ROCK artifact + - name: Upload locally built rock artifact uses: actions/upload-artifact@v3 with: name: charmed-kafka diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index dc84054..157831d 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -1,4 +1,4 @@ -name: Publish ROCK +name: Publish rock on: push: branches: @@ -22,7 +22,7 @@ jobs: echo "track=${BRANCH%*\/*}" >> $GITHUB_OUTPUT id: branch_metadata - - name: Extract ROCK metadata + - name: Extract rock metadata shell: bash run: | VERSION=$(yq '(.version|split("-"))[0]' rockcraft.yaml) diff --git a/README.md b/README.md index e63c937..fb55452 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ -# Charmed Kafka ROCK +# Charmed Kafka rock [![Container Registry](https://img.shields.io/badge/Container%20Registry-published-blue)](https://github.com/canonical/charmed-kafka-rock/pkgs/container/charmed-kafka) [![Release](https://github.com/canonical/charmed-kafka-rock/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-kafka-rock/actions/workflows/publish.yaml) -This repository contains the packaging metadata for creating a Charmed Kafka ROCK. This ROCK image is based on the [Charmed Kafka Snap](https://github.com/canonical/charmed-kafka-snap) +This repository contains the packaging metadata for creating a Charmed Kafka rock. This rock image is based on the [Charmed Kafka Snap](https://github.com/canonical/charmed-kafka-snap) -For more information on ROCKs, visit the [rockcraft Github](https://github.com/canonical/rockcraft). +For more information on rocks, visit the [rockcraft Github](https://github.com/canonical/rockcraft). -## Building the ROCK -The steps outlined below are based on the assumption that you are building the ROCK with the latest LTS of Ubuntu. +## Building the rock + +The steps outlined below are based on the assumption that you are building the rock with the latest LTS of Ubuntu. If you are using another version of Ubuntu or another operating system, the process may be different. To avoid any issue with other operating systems you can simply build the image with [multipass](https://multipass.run/): ```bash @@ -35,14 +36,16 @@ sudo usermod -aG docker $USER sudo lxd init --auto ``` *_NOTE:_* You will need to open a new shell for the group change to take effect (i.e. `su - $USER`) -### Packing and Running the ROCK + +### Packing and Running the rock + ```bash rockcraft pack sudo skopeo --insecure-policy copy oci-archive:charmed-kafka*.rock docker-daemon:/charmed-kafka: docker run --rm -it /charmed-kafka: ``` ## License -The Charmed Kafka ROCK is free software, distributed under the Apache +The Charmed Kafka rock is free software, distributed under the Apache Software License, version 2.0. See [LICENSE](https://github.com/canonical/charmed-kafka-rock/blob/main/LICENSE) for more information. diff --git a/rockcraft.yaml b/rockcraft.yaml index b73293f..efcf063 100644 --- a/rockcraft.yaml +++ b/rockcraft.yaml @@ -1,10 +1,10 @@ # Copyright 2023 Canonical Ltd. # See LICENSE file for licensing details. --- -name: charmed-kafka # the name of your ROCK -base: ubuntu@22.04 # the base environment for this ROCK +name: charmed-kafka # the name of your rock +base: ubuntu@22.04 # the base environment for this rock version: '3.6.1' # just for humans. Semantic versioning is recommended -summary: Charmed Kafka ROCK OCI # 79 char long summary +summary: Charmed Kafka rock OCI # 79 char long summary description: | This is an OCI image that bundles Apache Kafka together with other tools of its ecosystem in order to be used in Charmed Operators, providing @@ -14,7 +14,7 @@ description: | cloud native technologies. license: Apache-2.0 # your application's SPDX license -platforms: # The platforms this ROCK should be built on and run on +platforms: # The platforms this rock should be built on and run on amd64: services: