diff --git a/README.md b/README.md index ca6a029..7ef4ce5 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ there are several extensions defined as development dependencies in To make changes locally to the extensions run `npm run dev:setup` script in the `antora` directory. The script assumes that the local clones of -[ec-cli](https://github.com/enterprise-contract/ec-cli/) and +[ec](https://github.com/conforma/cli/) and [policy](https://github.com/conforma/policy/) repositories are present in the directory above this one. The outcome of running the `dev:setup` script is that local copies of the NPM packages that comprise the diff --git a/antora/antora-playbook.yml b/antora/antora-playbook.yml index 363ca14..b48bf85 100644 --- a/antora/antora-playbook.yml +++ b/antora/antora-playbook.yml @@ -29,7 +29,7 @@ content: - url: https://github.com/conforma/policy.git start_path: antora/docs - - url: https://github.com/enterprise-contract/ec-cli.git + - url: https://github.com/conforma/cli.git start_path: docs - url: https://github.com/enterprise-contract/enterprise-contract-controller.git diff --git a/antora/supplemental-ui/helpers/componentTitle.cjs b/antora/supplemental-ui/helpers/componentTitle.cjs index 361fc48..480c5d1 100644 --- a/antora/supplemental-ui/helpers/componentTitle.cjs +++ b/antora/supplemental-ui/helpers/componentTitle.cjs @@ -4,7 +4,7 @@ const customTitles = { "user-guide": "About", - "ec-cli": "CLI Reference", + "cli": "CLI Reference", "ecc": "Configuration Reference", "policy": "Policies", } diff --git a/antora/supplemental-ui/helpers/sortComponents.cjs b/antora/supplemental-ui/helpers/sortComponents.cjs index 6d7690a..5563a06 100644 --- a/antora/supplemental-ui/helpers/sortComponents.cjs +++ b/antora/supplemental-ui/helpers/sortComponents.cjs @@ -6,7 +6,7 @@ const objectValues = function (obj) { const componentOrder = [ "user-guide", - "ec-cli", + "cli", "ecc", "policy", ] diff --git a/conforma.github.io.code-workspace b/conforma.github.io.code-workspace index 6add947..ac7e002 100644 --- a/conforma.github.io.code-workspace +++ b/conforma.github.io.code-workspace @@ -4,13 +4,13 @@ "path": "." }, { - "path": "../ec-cli/reference-antora-extension" + "path": "../cli/reference-antora-extension" }, { - "path": "../ec-cli/rego-antora-extension" + "path": "../cli/rego-antora-extension" }, { - "path": "../ec-cli/tekton-task-antora-extension" + "path": "../cli/tekton-task-antora-extension" }, { "path": "../policy/antora/policy-antora-extension" diff --git a/website/assets/js/07-download.js b/website/assets/js/07-download.js index 24324d9..eaf46ae 100644 --- a/website/assets/js/07-download.js +++ b/website/assets/js/07-download.js @@ -4,7 +4,7 @@ document.addEventListener('DOMContentLoaded', async () => { return } try { - const response = await fetch('https://api.github.com/repos/enterprise-contract/ec-cli/releases/tags/snapshot'); + const response = await fetch('https://api.github.com/repos/conforma/cli/releases/tags/snapshot'); const snapshot = await response.json(); const uap = new UAParser(); const os = uap.getOS().name.replace('macOS', 'darwin').toLowerCase(); diff --git a/website/config/_default/menu.toml b/website/config/_default/menu.toml index ed0aa34..19bde30 100644 --- a/website/config/_default/menu.toml +++ b/website/config/_default/menu.toml @@ -26,13 +26,13 @@ [[main]] name = 'CLI Reference' parent = 'Documentation' - url = '/docs/ec-cli/ec_validate_image.html' + url = '/docs/cli/ec_validate_image.html' weight = 20 [[main]] name = 'Tekton Tasks' parent = 'Documentation' - url = '/docs/ec-cli/verify-enterprise-contract.html' + url = '/docs/cli/verify-enterprise-contract.html' weight = 30 [[main]] diff --git a/website/content/_index.md b/website/content/_index.md index 35e095f..6498a5d 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -2,6 +2,6 @@ kind: home --- -### [{{< icon "arrow-down-circle" >}} Download](https://github.com/enterprise-contract/ec-cli/releases/tag/snapshot){#download .button} +### [{{< icon "arrow-down-circle" >}} Download](https://github.com/conforma/cli/releases/tag/snapshot){#download .button} ### [{{< icon "book-open" >}} Getting Started](docs/user-guide/hitchhikers-guide.html){.button} diff --git a/website/content/posts/gating-image-promotion-on-gitlab.md b/website/content/posts/gating-image-promotion-on-gitlab.md index 6d536bb..818c8ec 100644 --- a/website/content/posts/gating-image-promotion-on-gitlab.md +++ b/website/content/posts/gating-image-promotion-on-gitlab.md @@ -215,7 +215,7 @@ come from this particular branch in this particular repository. validate: stage: promote image: - name: quay.io/enterprise-contract/ec-cli:snapshot + name: quay.io/conforma/cli:snapshot entrypoint: [""] variables: DOCKER_IMAGE_NAME: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHORT_SHA @@ -356,7 +356,7 @@ secure: validate: stage: promote image: - name: quay.io/enterprise-contract/ec-cli:snapshot + name: quay.io/conforma/cli:snapshot entrypoint: [""] variables: DOCKER_IMAGE_NAME: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHORT_SHA diff --git a/website/content/posts/introducing-action-validate-image.md b/website/content/posts/introducing-action-validate-image.md index 286bf59..2c8bcbc 100644 --- a/website/content/posts/introducing-action-validate-image.md +++ b/website/content/posts/introducing-action-validate-image.md @@ -5,7 +5,7 @@ author: "Sean Conroy" --- You may already be familiar -with using the `EC-CLI Validate` command for local container image validation. +with using the `EC Validate` command for local container image validation. Now, you can seamlessly integrate this functionality directly into your build processes or any other automated workflow in GitHub. @@ -22,7 +22,7 @@ processes or any other automated workflow in GitHub. - **GitHub Native**: Being a GitHub Action, EC Validate seamlessly integrates into your existing GitHub workflows, while also providing GitHub summary output. - **Policy Compliance**: Ability to tailor its validation checks based on custom or pre-defined policies. - **Integrity Checks**: Verifies that the image hasn't been tampered with. -- **[Signature Verification Support](https://conforma.dev/docs/ec-cli/signing.html)**: Offers support for verifying both long-lived public-key signed, and keyless signed container images. +- **[Signature Verification Support](https://conforma.dev/docs/cli/signing.html)**: Offers support for verifying both long-lived public-key signed, and keyless signed container images. Interested in learning more? Visit the EC Validate action in [GitHub's Market Place](https://github.com/marketplace/actions/ec-validate) for a user guide. @@ -113,7 +113,7 @@ Here is a version of the EC Action Validate that verifies artifacts signed by co - **`image`**: Similar to keyless, specifies the container image to be validated. - **`key`**: The public key used for long-lived authentication. - **`policy`**: Policy configuration, which can be either [predefined](https://github.com/enterprise-contract/config) or custom. -- **`extra-params`**: Additional parameters for the action, such as ignoring Rekor for this image. More can be found [here](https://conforma.dev/docs/ec-cli/ec_validate_image.html#_options) +- **`extra-params`**: Additional parameters for the action, such as ignoring Rekor for this image. More can be found [here](https://conforma.dev/docs/cli/ec_validate_image.html#_options) By using either keyless or long-lived authentication methods, you can tailor EC Action Validate to meet the specific security requirements of your project. diff --git a/website/content/posts/introducing-the-enterprise-contract.md b/website/content/posts/introducing-the-enterprise-contract.md index 2358423..09ba746 100644 --- a/website/content/posts/introducing-the-enterprise-contract.md +++ b/website/content/posts/introducing-the-enterprise-contract.md @@ -102,7 +102,7 @@ you want a configuration that can be shared across different teams? This is where the Enterprise Contract comes into play! The Enterprise Contract can be evaluated via the -[ec-cli](https://github.com/enterprise-contract/ec-cli). The simplest example involves using an +[cli](https://github.com/conforma/cli). The simplest example involves using an empty policy: ```yaml @@ -136,7 +136,7 @@ policy: success: true ``` -The ec-cli has different output formats. I chose the one that displays the full report in YAML +The cli has different output formats. I chose the one that displays the full report in YAML format. From its success, we can tell that the image signature and the image attestations match the provided public key. We can also see some metadata information about the found attestations. @@ -166,7 +166,7 @@ rekorUrl: "" ``` The sources attribute specifies a list of rego policy rules and corresponding [data -sources](https://conforma.dev/docs/ec-cli/configuration.html#_data_sources). Each data and +sources](https://conforma.dev/docs/cli/configuration.html#_data_sources). Each data and policy source can be specified via a different set of transports. Here we choose to use them directly from git. @@ -174,12 +174,12 @@ In configuration, we specify what to include from the sources. (Omit this to inc example, the policy rules from the [slsa_source_version_controlled](https://conforma.dev/docs/policy/packages/release_slsa_source_version_controlled.html) package are included. Check out the -[docs](https://conforma.dev/docs/ec-cli/configuration.html) for more information. +[docs](https://conforma.dev/docs/cli/configuration.html) for more information. We can also specify the public key and rekor URL directly in this file. This helps consolidate all the input parameters required for validating images. -Let’s run the ec-cli again with this policy in place: +Let’s run the cli again with this policy in place: ```bash $ ec validate image --policy policy.yaml --image $IMAGE --output yaml --info @@ -279,7 +279,7 @@ components: - containerImage: quay.io/example/three:latest@sha256:... ``` -Then run the ec-cli: +Then run the cli: ```bash $ ec validate image --policy policy.yaml --file-path components.yaml --output yaml diff --git a/website/layouts/_default/contribute.html b/website/layouts/_default/contribute.html index b2cb5d0..0e92d77 100644 --- a/website/layouts/_default/contribute.html +++ b/website/layouts/_default/contribute.html @@ -13,7 +13,7 @@ {{ partial "toolbar.html" . }}

Collaboration is Welcomed!

-

+

We encourage you to reach out and be part of our community.

@@ -24,11 +24,11 @@

Collaboration is Welcomed!

{{ partial "github-repo.html" (dict - "name" "ec-cli" + "name" "cli" "description" "Enterprise Contract command line interface" - "repo_url" "https://github.com/enterprise-contract/ec-cli" - "issue_url" "https://github.com/enterprise-contract/ec-cli/issues" - "discussion_url" "https://github.com/enterprise-contract/ec-cli/discussions" + "repo_url" "https://github.com/conforma/cli" + "issue_url" "https://github.com/conforma/cli/issues" + "discussion_url" "https://github.com/conforma/cli/discussions" ) }} {{ partial "github-repo.html" (dict