From cafdc6acb6be1a59e74667f5eb8e043de02cd394 Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Thu, 23 May 2024 10:02:09 +0200 Subject: [PATCH] chore: fix rocks terminology --- .github/workflows/build.yaml | 2 +- .github/workflows/publish.yaml | 2 +- .github/workflows/scan.yaml | 2 +- CONTRIBUTING.md | 10 +++++----- README.md | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index ef6b8ca..0e46f89 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,4 +1,4 @@ -name: Build ROCK +name: Build rock on: workflow_call: diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index b8df92c..d4d2936 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -1,4 +1,4 @@ -name: Publish ROCK +name: Publish rock on: workflow_call: diff --git a/.github/workflows/scan.yaml b/.github/workflows/scan.yaml index 6a336e6..2f55d12 100644 --- a/.github/workflows/scan.yaml +++ b/.github/workflows/scan.yaml @@ -1,4 +1,4 @@ -name: Scan ROCK +name: Scan rock on: workflow_call: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cc9c3f..448072a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Please refer to the [rockcraft](https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/index.html) -documentations to learn how to develop a ROCK image. +documentations to learn how to develop a rock. Please install `pre-commit` hooks to help enforce various validations: @@ -14,14 +14,14 @@ pre-commit install -t commit-msg ## Building & Running Locally -You can build the ROCK image using the following command: +You can build the rock using the following command: ```shell rockcraft pack -v ``` Assuming the [`skopeo`](https://snapcraft.io/install/skopeo/ubuntu) has been -installed. Import the created ROCK image into Docker: +installed. Import the created rock into Docker: ```shell sudo /snap/rockcraft/current/bin/skopeo --insecure-policy copy oci-archive:.rock docker-daemon:: @@ -46,7 +46,7 @@ docker run -d \ ### Prerequisites -Before deploying the GLAuth ROCK image locally, there are several prerequisites: +Before deploying the GLAuth rock locally, there are several prerequisites: - Enable the MicroK8s' [built-in registry](https://microk8s.io/docs/registry-built-in) @@ -69,7 +69,7 @@ docker push localhost:32000/: ### Deploy -Run the following command to deploy a locally-built ROCK image with +Run the following command to deploy a locally-built rock with the [glauth-k8s-operator](https://github.com/canonical/glauth-k8s-operator) charm: diff --git a/README.md b/README.md index 30b9bee..2f7ae78 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# GLAuth ROCKs +# GLAuth rocks ![Latest Version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcanonical%2Fglauth-rock%2Fmain%2Frockcraft.yaml&query=%24.version&label=Release&color=red) ![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?logo=postgresql&logoColor=white) @@ -8,11 +8,11 @@ [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196.svg)](https://conventionalcommits.org) -[ROCKs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/#rocks-explanation) +[Rocks](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/#rocks-explanation) for [GLAuth](https://github.com/glauth/glauth). -This repository holds all the necessary files to build ROCKs for the upstream -GLAuth LDAP server. The GLAuth ROCK is used by +This repository holds all the necessary files to build rocks for the upstream +GLAuth LDAP server. The GLAuth rock is used by the [glauth-k8s-operator](https://github.com/canonical/glauth-k8s-operator) charm.