From 3d401ab425fabc65c246798eb1fdcf5495bf489a Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Thu, 23 May 2024 09:24:06 +0200 Subject: [PATCH] chore: fix rocks terminology --- .github/workflows/build.yaml | 6 +++--- .github/workflows/publish.yaml | 4 ++-- README.md | 15 +++++++++------ rockcraft.yaml | 8 ++++---- 4 files changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 5cdc6fb..9215fda 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 }} @@ -39,7 +39,7 @@ jobs: run: | sudo snap install yq sudo snap install rockcraft --classic --edge - - name: Build ROCK + - name: Build rock id: build run: | VERSION=$(yq '.version' rockcraft.yaml) @@ -48,7 +48,7 @@ jobs: echo "rock=charmed-zookeeper_${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-zookeeper diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index a2fb625..b855546 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 cef0404..fce7509 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -# Zookeeper ROCK +# Zookeeper rock [![Release](https://github.com/canonical/charmed-zookeeper-rock/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-zookeeper-rock/actions/workflows/publish.yaml) [![Container Registry](https://img.shields.io/badge/Container%20Registry-published-blue)](https://github.com/canonical/charmed-zookeeper-rock/pkgs/container/charmed-zookeeper) -This repository contains the packaging metadata for creating a ROCK of Zookeeper built from the official Zookeeper release artifacts. For more information on ROCKs, visit the [rockcraft Github](https://github.com/canonical/rockcraft). +This repository contains the packaging metadata for creating a rock of Zookeeper built from the official Zookeeper release artifacts. 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. If you are using another version of Ubuntu or another operating system, the process may be different. +## 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. ### Clone Repository ```bash @@ -26,14 +27,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:zookeeper*.rock docker-daemon:/zookeeper: docker run --rm -it /zookeeper: ``` ## License -The Zookeeper ROCK is free software, distributed under the Apache +The Zookeeper rock is free software, distributed under the Apache Software License, version 2.0. See [LICENSE](https://github.com/canonical/zookeeper-rock/blob/3.6/stable/LICENSE) for more information. diff --git a/rockcraft.yaml b/rockcraft.yaml index 61f4e12..74872fe 100644 --- a/rockcraft.yaml +++ b/rockcraft.yaml @@ -1,10 +1,10 @@ # Copyright 2023 Canonical Ltd. # See LICENSE file for licensing details. --- -name: charmed-zookeeper # the name of your ROCK -base: ubuntu@22.04 # the base environment for this ROCK +name: charmed-zookeeper # the name of your rock +base: ubuntu@22.04 # the base environment for this rock version: '3.8.4' # just for humans. Semantic versioning is recommended -summary: Charmed ZooKeeper ROCK OCI # 79 char long summary +summary: Charmed ZooKeeper rock OCI # 79 char long summary description: | This is an OCI image that bundles Apache ZooKeeper 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: environment: