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

channel list output is confusing #755

Open
jmesnil opened this issue Sep 6, 2024 · 1 comment
Open

channel list output is confusing #755

jmesnil opened this issue Sep 6, 2024 · 1 comment
Labels
good first issue Good for newcomers ready Issue can be worked on

Comments

@jmesnil
Copy link
Member

jmesnil commented Sep 6, 2024

The output of channel list is confusing... It looks like YAML file but it's not. It looks like a channel definition but it's not.

$ prospero channel list
Server /Users/jmesnil/Developer/wildfly/dist/target/wildfly-34.0.0.Beta1-SNAPSHOT/. is subscribed to following channels:

-------
# wildfly
  manifest: org.wildfly.channels:wildfly:34.0.0.Beta1-SNAPSHOT
  repositories:
    id: jboss-public-repository-group
    url: https://repository.jboss.org/nexus/content/groups/public/
    id: central
    url: https://repo.maven.apache.org/maven2
    id: jboss-ga-repository
    url: https://maven.repository.redhat.com/ga/
-------
  • # wildfly actually correspond to the name of the channel.
  • manifest is a different representation of the manifest coordinates (Maven GAV or URL)
  • repositories kind of represents array items

I'm not sure to understand why this command does not output the actual content of the .installation/installer_channels.yaml:

$ cat .installation/installer-channels.yaml
---
schemaVersion: "2.0.0"
name: "wildfly"
repositories:
  - id: "jboss-public-repository-group"
    url: "https://repository.jboss.org/nexus/content/groups/public/"
  - id: "central"
    url: "https://repo.maven.apache.org/maven2"
  - id: "jboss-ga-repository"
    url: "https://maven.repository.redhat.com/ga/"
manifest:
  maven:
    groupId: "org.wildfly.channels"
    artifactId: "wildfly"
    version: "34.0.0.Beta1-SNAPSHOT"
noStreamStrategy: "none"

Maybe we could provide a short and long output for channel list.
The short list would display the name of the channel as well as the manifest GAV or URL (which are the most important information) while the long list would dump .installation/installer_channels.yaml (which would be a valid YAML file corresponding to channel definitions).

Something like:

$ prospero channel list
wildfly org.wildfly.channels:wildfly:34.0.0.Beta1-SNAPSHOT

$ prospero channel list --full
---
schemaVersion: "2.0.0"
name: "wildfly"
repositories:
  - id: "jboss-public-repository-group"
    url: "https://repository.jboss.org/nexus/content/groups/public/"
  - id: "central"
    url: "https://repo.maven.apache.org/maven2"
  - id: "jboss-ga-repository"
    url: "https://maven.repository.redhat.com/ga/"
manifest:
  maven:
    groupId: "org.wildfly.channels"
    artifactId: "wildfly"
    version: "34.0.0.Beta1-SNAPSHOT"
noStreamStrategy: "none"

@spyrkob WDYT?

@spyrkob
Copy link
Collaborator

spyrkob commented Sep 6, 2024

@jmesnil thanks, that's a good idea. If I remember right I was trying to make the output smaller, but it makes sense to add option to print whole definition as well

@spyrkob spyrkob added good first issue Good for newcomers ready Issue can be worked on labels Sep 6, 2024
parsharma added a commit to parsharma/prospero that referenced this issue Oct 16, 2024
parsharma added a commit to parsharma/prospero that referenced this issue Oct 22, 2024
parsharma added a commit to parsharma/prospero that referenced this issue Oct 23, 2024
spyrkob added a commit that referenced this issue Oct 23, 2024
channel list output is confusing #755
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers ready Issue can be worked on
Projects
None yet
Development

No branches or pull requests

2 participants