Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve output of ec inspect policy-data #1810

Open
lcarva opened this issue Jul 30, 2024 · 0 comments
Open

Improve output of ec inspect policy-data #1810

lcarva opened this issue Jul 30, 2024 · 0 comments

Comments

@lcarva
Copy link
Member

lcarva commented Jul 30, 2024

Currently, the command displays the data as is:

🐚 ec inspect policy-data --source github.com/release-engineering/rhtap-ec-policy//data -o yaml | yq . | head
pipeline-required-tasks:
  docker:
    - effective_on: "2024-06-17T00:00:00Z"
      tasks:
        - - buildah
          - buildah-10gb
          - buildah-6gb
          - buildah-8gb
          - buildah-remote
          - buildah-oci-ta
...

It would be great if it also provided some description for what each rule data value represents and how it is used.

lcarva added a commit to lcarva/rhtap-ec-policy that referenced this issue Jul 30, 2024
Remove the antora extension that generates the documentation for the
data files defined in this repository.

There are a couple of reasons for this.

First, it is our understanding that the webpage that uses the antora
extension is rarely used. A quick sample of some users reveal that they
weren't even aware of its existence.

Second, this is very specific to Konflux and arugably does not really
belong in the upstream EC website.

enterprise-contract/ec-cli#1810 has been
created to make the output of `ec inspect policy-data` a little more
informative which could be useful for others.

Ref: EC-587

Signed-off-by: Luiz Carvalho <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant