diff --git a/README.md b/README.md index 7fa570f..39426f9 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,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-policies](https://github.com/enterprise-contract/ec-policies/) repositories +[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 extensions are [linked](https://docs.npmjs.com/cli/v6/commands/npm-link), so diff --git a/antora/README.md b/antora/README.md index f039ba1..68c886c 100644 --- a/antora/README.md +++ b/antora/README.md @@ -18,7 +18,7 @@ With `hack/local-build.sh` script performs this by creating a temporary playbook file pointing to the local clones of the mentioned repositories if those repositories are located in the `../` for a `https://github.com//.git` git URL. For example, it is expected -that the `ec-policies` repository is located at `../ec-policies`. If the local +that the `policy` repository is located at `../policy`. If the local repository is on a different path create a symlink pointing from `../` to that path. diff --git a/antora/antora-playbook.yml b/antora/antora-playbook.yml index e3d3fa4..363ca14 100644 --- a/antora/antora-playbook.yml +++ b/antora/antora-playbook.yml @@ -26,7 +26,7 @@ site: robots: allow content: sources: - - url: https://github.com/enterprise-contract/ec-policies.git + - url: https://github.com/conforma/policy.git start_path: antora/docs - url: https://github.com/enterprise-contract/ec-cli.git diff --git a/antora/supplemental-ui/helpers/componentTitle.cjs b/antora/supplemental-ui/helpers/componentTitle.cjs index f5ad124..361fc48 100644 --- a/antora/supplemental-ui/helpers/componentTitle.cjs +++ b/antora/supplemental-ui/helpers/componentTitle.cjs @@ -6,7 +6,7 @@ const customTitles = { "user-guide": "About", "ec-cli": "CLI Reference", "ecc": "Configuration Reference", - "ec-policies": "Policies", + "policy": "Policies", } module.exports = (component) => { diff --git a/antora/supplemental-ui/helpers/sortComponents.cjs b/antora/supplemental-ui/helpers/sortComponents.cjs index b0808bf..6d7690a 100644 --- a/antora/supplemental-ui/helpers/sortComponents.cjs +++ b/antora/supplemental-ui/helpers/sortComponents.cjs @@ -8,7 +8,7 @@ const componentOrder = [ "user-guide", "ec-cli", "ecc", - "ec-policies", + "policy", ] const componentSorter = function (a, b) { diff --git a/conforma.github.io.code-workspace b/conforma.github.io.code-workspace index 27ac6c8..6add947 100644 --- a/conforma.github.io.code-workspace +++ b/conforma.github.io.code-workspace @@ -13,7 +13,7 @@ "path": "../ec-cli/tekton-task-antora-extension" }, { - "path": "../ec-policies/antora/ec-policies-antora-extension" + "path": "../policy/antora/policy-antora-extension" } ], "settings": {} diff --git a/website/config/_default/menu.toml b/website/config/_default/menu.toml index d43e5d8..ed0aa34 100644 --- a/website/config/_default/menu.toml +++ b/website/config/_default/menu.toml @@ -44,7 +44,7 @@ [[main]] name = 'Policies' parent = 'Documentation' - url = '/docs/ec-policies/release_policy.html' + url = '/docs/policy/release_policy.html' weight = 60 [[main]] diff --git a/website/content/posts/a-taste-of-policies.md b/website/content/posts/a-taste-of-policies.md index f5e2ca9..41b1ee2 100644 --- a/website/content/posts/a-taste-of-policies.md +++ b/website/content/posts/a-taste-of-policies.md @@ -67,8 +67,8 @@ identity: sources: - policy: - - github.com/enterprise-contract/ec-policies//policy/lib - - github.com/enterprise-contract/ec-policies//policy/release + - github.com/conforma/policy//policy/lib + - github.com/conforma/policy//policy/release ruleData: allowed_gh_workflow_repos: - lcarva/festoji @@ -86,7 +86,7 @@ configuration: This policy moves the certificate flags to the policy itself. It also specifies certain policy rules to be executed. Here we are including some of the existing Enterprise Contract policy rules, -[github_certificate](https://conforma.dev/docs/ec-policies/release_policy.html#github_certificate_package). +[github_certificate](https://conforma.dev/docs/policy/release_policy.html#github_certificate_package). These policy rules rely on certain data to be provided, e.g. the expected GitHub Workflow repository. With this policy saved as `policy.yaml`, we can simplify how the CLI is invoked: @@ -189,7 +189,7 @@ deny contains result if { This defines a single policy rule that verifies the materials section of the SLSA Provenance contain the expected git repository. The Enterprise Contract relies on rego annotations to provide additional information about each of the policy rules. See the -[docs](https://conforma.dev/docs/ec-policies/authoring.html) for more information. +[docs](https://conforma.dev/docs/policy/authoring.html) for more information. Let's add this rule to our previous policy: @@ -202,8 +202,8 @@ identity: sources: - policy: - - github.com/enterprise-contract/ec-policies//policy/lib - - github.com/enterprise-contract/ec-policies//policy/release + - github.com/conforma/policy//policy/lib + - github.com/conforma/policy//policy/release ruleData: allowed_gh_workflow_repos: - lcarva/festoji diff --git a/website/content/posts/evaluating-custom-predicates.md b/website/content/posts/evaluating-custom-predicates.md index 6f87838..82d2703 100644 --- a/website/content/posts/evaluating-custom-predicates.md +++ b/website/content/posts/evaluating-custom-predicates.md @@ -111,7 +111,7 @@ _bacon_attestations := [attestation | ] ``` -(Check out the [docs](https://conforma.dev/docs/ec-policies/authoring.html) for more +(Check out the [docs](https://conforma.dev/docs/policy/authoring.html) for more information on how to author policy rules 🔥) Next, we create a policy configuration, `policy.yaml`, to use the policy rules above. diff --git a/website/content/posts/gating-image-promotion-on-gitlab.md b/website/content/posts/gating-image-promotion-on-gitlab.md index 1e28017..e13310f 100644 --- a/website/content/posts/gating-image-promotion-on-gitlab.md +++ b/website/content/posts/gating-image-promotion-on-gitlab.md @@ -250,8 +250,8 @@ identity: issuer: https://gitlab.com sources: # <- added - policy: - - github.com/enterprise-contract/ec-policies//policy/lib - - github.com/enterprise-contract/ec-policies//policy/release + - github.com/conforma/policy//policy/lib + - github.com/conforma/policy//policy/release config: include: - slsa_source_correlated @@ -296,7 +296,7 @@ GitLab. [GitLab container registry]: https://docs.gitlab.com/ee/user/packages/container_registry/ [identity-based]: https://docs.sigstore.dev/signing/overview/ [SLSA Provenance]: https://slsa.dev/spec/v1.0/ -[slsa_source_correlated]: https://conforma.dev/docs/ec-policies/release_policy.html#slsa_source_correlated_package +[slsa_source_correlated]: https://conforma.dev/docs/policy/release_policy.html#slsa_source_correlated_package ## Appendix diff --git a/website/content/posts/introducing-the-enterprise-contract.md b/website/content/posts/introducing-the-enterprise-contract.md index 207a603..a02dbfd 100644 --- a/website/content/posts/introducing-the-enterprise-contract.md +++ b/website/content/posts/introducing-the-enterprise-contract.md @@ -141,7 +141,7 @@ format. From its success, we can tell that the image signature and the image att provided public key. We can also see some metadata information about the found attestations. Let’s take a step further and say we want to validate the SLSA Provenance attestations with a -certain set of policy rules. The [ec-policies](https://github.com/enterprise-contract/ec-policies) +certain set of policy rules. The [policy](https://github.com/conforma/policy) repo has a set of useful rego policies, so let’s use that. Create a policy file called `policy.yaml` with the following content: @@ -150,10 +150,10 @@ Create a policy file called `policy.yaml` with the following content: sources: - name: policies data: - - git::github.com/enterprise-contract/ec-policies.git//data?ref=bca7d72 + - git::github.com/conforma/policy.git//data?ref=bca7d72 policy: - - git::github.com/enterprise-contract/ec-policies.git//policy/lib?ref=bca7d72 - - git::github.com/enterprise-contract/ec-policies.git//policy/release?ref=bca7d72 + - git::github.com/conforma/policy.git//policy/lib?ref=bca7d72 + - git::github.com/conforma/policy.git//policy/release?ref=bca7d72 configuration: include: - slsa_source_version_controlled @@ -172,7 +172,7 @@ directly from git. In configuration, we specify what to include from the sources. (Omit this to include all!) In this example, the policy rules from the -[slsa_source_version_controlled](https://conforma.dev/docs/ec-policies/release_policy.html#slsa_source_version_controlled_package) +[slsa_source_version_controlled](https://conforma.dev/docs/policy/release_policy.html#slsa_source_version_controlled_package) package are included. Check out the [docs](https://conforma.dev/docs/ec-cli/configuration.html) for more information. @@ -253,11 +253,11 @@ policy: -----END PUBLIC KEY----- sources: - data: - - git::github.com/enterprise-contract/ec-policies.git//data?ref=bca7d72 + - git::github.com/conforma/policy.git//data?ref=bca7d72 name: policies policy: - - git::github.com/enterprise-contract/ec-policies.git//policy/lib?ref=bca7d72 - - git::github.com/enterprise-contract/ec-policies.git//policy/release?ref=bca7d72 + - git::github.com/conforma/policy.git//policy/lib?ref=bca7d72 + - git::github.com/conforma/policy.git//policy/release?ref=bca7d72 success: true ``` diff --git a/website/layouts/_default/contribute.html b/website/layouts/_default/contribute.html index d8fb9a7..b2cb5d0 100644 --- a/website/layouts/_default/contribute.html +++ b/website/layouts/_default/contribute.html @@ -32,10 +32,10 @@

Collaboration is Welcomed!

) }} {{ partial "github-repo.html" (dict - "name" "ec-policies" + "name" "policy" "description" "Rego policies related to Konflux Enterprise Contract" - "repo_url" "https://github.com/enterprise-contract/ec-policies" - "issue_url" "https://github.com/enterprise-contract/ec-policies/issues" + "repo_url" "https://github.com/conforma/policy" + "issue_url" "https://github.com/conforma/policy/issues" ) }} {{ partial "github-repo.html" (dict