Skip to content

Commit

Permalink
chore: fix rocks terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro committed May 23, 2024
1 parent dd11cce commit cafdc6a
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build ROCK
name: Build rock

on:
workflow_call:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish ROCK
name: Publish rock

on:
workflow_call:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/scan.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Scan ROCK
name: Scan rock

on:
workflow_call:
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:<local-rock-name>.rock docker-daemon:<image-name>:<image-tag>
Expand All @@ -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)
Expand All @@ -69,7 +69,7 @@ docker push localhost:32000/<image-name>:<image-tag>

### 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:

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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.

Expand Down

0 comments on commit cafdc6a

Please sign in to comment.