From 42bc4fd01b7b8a3b41c6dca6d26dbf740612d5f3 Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Thu, 23 May 2024 10:00:28 +0200 Subject: [PATCH] chore: fix rocks terminology --- .github/workflows/build.yaml | 6 +++--- .github/workflows/publish.yaml | 2 +- README.md | 17 ++++++++++------- rockcraft.yaml | 2 +- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index d5d3a0d..801f25f 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 }} @@ -34,7 +34,7 @@ jobs: run: | sudo snap install yq sudo snap install rockcraft --classic --edge - - name: Build ROCK + - name: Build rock run: | app_version=$(yq '.version' rockcraft.yaml) version=$(yq '(.version|split("-"))[0]' rockcraft.yaml) @@ -45,7 +45,7 @@ jobs: sed -i "0,/${app_version}/{s//${tag}/}" rockcraft.yaml rockcraft pack --verbose - - name: Upload locally built ROCK artifact + - name: Upload locally built rock artifact uses: actions/upload-artifact@v3 with: name: charmed-superset-rock diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 17e7037..6a6863c 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -1,4 +1,4 @@ -name: Publish ROCK +name: Publish rock on: push: branches: diff --git a/README.md b/README.md index b88a4fe..4a874c8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# Charmed Apache Superset ROCK +# Charmed Apache Superset rock -This repository contains the packaging metadata for creating a Charmed Superset ROCK. This ROCK image is based on the upstream [Apache Superset](https://downloads.apache.org/superset/) image. +This repository contains the packaging metadata for creating a Charmed Superset rock. This rock is based on the upstream [Apache Superset](https://downloads.apache.org/superset/) image. -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,7 +36,9 @@ newgrp docker sudo snap disable docker sudo snap enable docker ``` -### Packing and Running the ROCK + +### Packing and Running the rock + ```bash rockcraft pack sudo skopeo --insecure-policy copy oci-archive:charmed-superset-rock_2.1.0-22.04-edge_amd64.rock docker-daemon:charmed-superset-rock:2.1.0 @@ -61,7 +64,7 @@ Further information on connecting data sources and creating dashboards can be fo `make clean-all` will remove the image and get you ready to start from `make dev` ## License -The Charmed Superset ROCK is free software, distributed under the Apache +The Charmed Superset rock is free software, distributed under the Apache Software License, version 2.0. See [LICENSE](https://github.com/canonical/charmed-superset-rock/blob/main/LICENSE) for more information. diff --git a/rockcraft.yaml b/rockcraft.yaml index 9e2f169..8f996a2 100644 --- a/rockcraft.yaml +++ b/rockcraft.yaml @@ -5,7 +5,7 @@ name: charmed-superset-rock base: ubuntu@22.04 version: 2.1.0-22.04-edge -summary: Charmed Superset ROCK OCI +summary: Charmed Superset rock OCI description: | Superset is a business intelligence tool that is fast, lightweight, intuitive, and loaded with options that make it easy for users