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 22, 2024
1 parent 076d12c commit fe21715
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@

-----

*Picture of a cool ROCK:*
*Picture of a cool rock:*
4 changes: 2 additions & 2 deletions .github/workflows/Build-Rock.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
rock_name=`cat rockcraft.y*ml | yq -r .name`
if [[ "${{ inputs.oci-factory-path }}" != *"${rock_name}"* ]]
then
echo "ERROR: the ROCK's name '${rock_name}' must match the OCI folder name!"
echo "ERROR: the rock's name '${rock_name}' must match the OCI folder name!"
exit 1
fi
- uses: actions/setup-python@v5
Expand Down Expand Up @@ -157,7 +157,7 @@ jobs:
python3 ${rocks_toolbox}/rockcraft_lpci_build/rockcraft_lpci_build.py \
--lp-credentials-b64 "${{ secrets.LP_CREDENTIALS_B64 }}" \
--launchpad-accept-public-upload
- name: Rename ROCK OCI archive
- name: Rename rock OCI archive
id: rock
run: |
mkdir ${{ env.ROCKS_CI_FOLDER }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ jobs:
copy oci:${{ env.TEST_IMAGE_NAME}}:${{ env.TEST_IMAGE_TAG }} \
docker-daemon:${{ env.TEST_IMAGE_NAME}}:${{ env.TEST_IMAGE_TAG }}
- name: Test ROCK
- name: Test rock
run: |
set -ex
docker run --rm ${{ env.TEST_IMAGE_NAME}}:${{ env.TEST_IMAGE_TAG }} \
Expand Down
2 changes: 1 addition & 1 deletion IMAGE_MAINTAINER_AGREEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ registry namespace.
| | |
|---|---|
| CI/CD | Continuous Integration and Continuous Deployment |
| Maintainer | Canonical entity who owns and is responsible for an Ubuntu ROCK/Image. |
| Maintainer | Canonical entity who owns and is responsible for an Ubuntu Rock/Image. |
| OCI image | Currently limited to rock images only. |
| Registry | An OCI container registry, as [defined](https://oras.land/#what-are-oci-registries) by the OCI specification. |
| Rocks | Canonical’s OCI images, built via Rockcraft. See the definition [here](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation.html#what-is-a-rock). |
Expand Down
2 changes: 1 addition & 1 deletion oci/alertmanager/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >
silencing and inhibition of alerts.
Read more on the [official documentation](https://prometheus.io/docs/alerting/latest/alertmanager/)
Please note that this repository is now holding a ROCK, not a
Please note that this repository is now holding a rock, not a
Dockerfile-based image. As such the entrypoint is now Pebble. Read more on
the [Rockcraft docs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/).
# --- USAGE INFORMATION ---
Expand Down
2 changes: 1 addition & 1 deletion oci/charmed-opensearch/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 1
application: charmed-opensearch
is_chiselled: False
description: |
Charmed OpenSearch ROCK OCI. OpenSearch is a community-driven, Apache 2.0-licensed open source
Charmed OpenSearch rock. OpenSearch is a community-driven, Apache 2.0-licensed open source
search and analytics suite that makes it easy to ingest, search, visualize, and analyze data.
Developers build with OpenSearch for use cases such as application search,
log analytics, data observability, data ingestion, and more.
4 changes: 2 additions & 2 deletions oci/grafana/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: >
Read more on the [Grafana website](https://grafana.com).
Please note that the images tagged up to 8.2 are Dockerfile-based images,
whereas from version 10.0.3 onward the images are now ROCKs. As such the
whereas from version 10.0.3 onward the images are now rocks. As such the
entrypoint is now Pebble. Read more on the
[Rockcraft docs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/).
# --- USAGE INFORMATION ---
Expand Down Expand Up @@ -47,6 +47,6 @@ debug:
```bash
# For Dockerfile-based images
docker exec -it grafana-container /bin/bash
# For ROCKs
# For rocks
docker exec -it grafana-container exec /bin/bash
```
2 changes: 1 addition & 1 deletion oci/kafka/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: |
to run properly.
Please note that the images tagged up to 3.1 are Dockerfile-base images,
whereas from version 3.6.1 onward the images are now ROCKs. As such the
whereas from version 3.6.1 onward the images are now rocks. As such the
entrypoint is now Pebble. Read more on the
[Rockcraft docs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/).
Expand Down
4 changes: 2 additions & 2 deletions oci/loki/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >
Read more on the [official website](https://grafana.com/oss/loki/).
Please note that the images tagged up to 2.4 are Dockerfile-base images,
whereas from version 2.8.4 onward the images are now ROCKs. As such the
whereas from version 2.8.4 onward the images are now rocks. As such the
entrypoint is now Pebble. Read more on the
[Rockcraft docs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/).
# --- USAGE INFORMATION ---
Expand Down Expand Up @@ -45,6 +45,6 @@ debug:
```bash
# For Dockerfile-based images
docker exec -it loki-container /bin/bash
# For ROCKs
# For rocks
docker exec -it loki-container exec /bin/bash
```
2 changes: 1 addition & 1 deletion oci/zookeeper/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: |
shipped in support of the Apache Kafka image.
Please note that the images tagged up to 3.1 are Dockerfile-base images,
whereas from version 3.8.2 onward the images are now ROCKs. As such the
whereas from version 3.8.2 onward the images are now rocks. As such the
entrypoint is now Pebble. Read more on the
[Rockcraft docs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/).
Expand Down
2 changes: 1 addition & 1 deletion src/uploads/infer_image_track.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def get_release_from_codename(codename: str) -> str:
base_release = float(rock_base.replace(":", "@").split("@")[-1])
except ValueError:
logging.warning(
f"Could not infer ROCK's base release from {rock_base}. Trying with codename."
f"Could not infer rock's base release from {rock_base}. Trying with codename."
)
base_release = float(
get_release_from_codename(rock_base.replace(":", "@").split("@")[-1])
Expand Down

0 comments on commit fe21715

Please sign in to comment.