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

Add versions table option to ckan show command #3414

Merged
merged 1 commit into from
Jul 29, 2021

Conversation

HebaruSan
Copy link
Member

Motivation

After KSP-CKAN/CKAN-meta#2389 updated the compatibility of 17 old modules and its parent PR used this illustration:

versions tab

... I said this and got a 👍 :

image

Problems

There are also lots and lots of things I don't like about the current ckan show command.

  • Only allows one mod to be searched at a time
  • The format is almost but not quite YAML-like
  • Extra blank line after description if it exists
  • Always shows "Status" field even if it isn't set, even though it's optional, non-functional, and usually not set
  • Always shows "Provides" section and includes the mod's own identifier in the list, introducing visual clutter
  • Missing tags and localizations data
  • Missing manual and version file links
  • Resource URLs not aligned the same as the "module info" section above

Changes

Now you can use ckan show --with-versions <identifier> to see the versions and compatible game versions, and all of the above annoyances are addressed. This will be particularly appreciated by all of our users in 1975 who use their PDP-11 computers by typing commands and inspecting the output from their dot matrix printers, or even those with brand new state of the art CRT displays:

image

Next steps

After this is merged, we can add --with-versions here for NetKAN validation:

https://github.com/KSP-CKAN/xKAN-meta_testing/blob/00c0a0b4c3eb79c7dc740bb1daae9cd3f2f23074/ckan_meta_tester/ckan_install_template.txt#L4

This will produce duplicated output for CKAN-meta when a PR modified multiple historical versions of the same mod, but we can worry about that problem later if it bothers us.

@HebaruSan HebaruSan added Enhancement New features or functionality Cmdline Issues affecting the command line Pull request labels Jul 14, 2021
Copy link
Member

@DasSkelett DasSkelett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
I think we can do the change to xKAN-meta_testing first, since it won't get deployed until we rebuild from this repo, and that way we wouldn't have to deploy twice.

@HebaruSan HebaruSan merged commit 79608b8 into KSP-CKAN:master Jul 29, 2021
@HebaruSan HebaruSan deleted the feature/show-version-table branch July 29, 2021 13:04
@HebaruSan
Copy link
Member Author

https://github.com/KSP-CKAN/CKAN-meta/runs/3192246022

  Version    Game Versions      
  ---------  -------------------
  1:1.6.5.0  KSP 1.8.1 and later
  1:1.6.4.2  KSP 1.8.1 and later
  1:1.6.4.1  KSP 1.8.1 and later
  1:1.6.4.0  KSP 1.8.1–1.9.1    
  1:1.6.3.1  KSP 1.3.1–1.4.5    
  1:1.6.3.0  KSP 1.3.1–1.4.4    
  1:1.6.2.2  KSP 1.3.1          
  1:1.6.2.1  KSP 1.3.1          
  1:1.6.1.2  KSP 1.3.1          
  1:1.6.1.1  KSP 1.3.1          
  1.6.1.0    KSP 1.3.1          
  1.6.0.1    KSP 1.3.1          
  1.6.0      KSP 1.3.1          
  1.5.99     KSP 1.3.1          
  1.5.88     KSP 1.3.1          
  1.5.3      KSP 1.3.1          
  1.5.2      KSP 1.3.0          
  1.5.1      KSP 1.3.0          

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cmdline Issues affecting the command line Enhancement New features or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants