galaxyproject / galaxyproject/total-perspective-vortex

replace long-term IDs by default with short-form IDs?

Open
#50 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
18
Forks
19
Avg merge
4d 9h
Merged PRs (30d)
5

Description

(not sure if this should be better discussed at the https://github.com/galaxyproject/tpv-shared-database repo)

Is there any reason we use the long-form IDs by default and need to add the `*` bits?

I think https://github.com/galaxyproject/tpv-shared-database/blob/main/tools.yml#L35 makes it rather hard for contributors to add new tools if they only know the short ID. In addition, the long ID increases the chance of hard-to-spot errors.

Is there any reason we use the long IDs by default? And why do we need to add the `*`, can this not be done by TPV?

In the example:

` toolshed.g2.bx.psu.edu/repos/bgruening/deeptools/deeptools_bamCompare/.*:`

Can we use by default `deeptools_bamCompare:`?
If people want to specify versions and be very strict they could use `toolshed.g2.bx.psu.edu/repos/bgruening/deeptools/deeptools_bamCompare/3.2.1+galaxy1:`

Thoughts?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing tools.yml around line 35 and the linked tpv-shared-database tools.yml entry, then compare how short and long IDs plus wildcard versions are represented. Confirm the intended default and whether TPV should add the wildcard; done when the decision is resolved and the relevant repository behavior or documentation reflects it.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
backend, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.