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

Append STRchive version number to files downloaded from /loci#downloads #96

Closed
hdashnow opened this issue Nov 30, 2024 · 3 comments
Closed
Labels
enhancement New feature or request lower-priority Nice to have, but not urgent

Comments

@hdashnow
Copy link
Member

Currently, downloaded files look like this:

hg19.STRchive-disease-loci.TRGT.BFiBXWeD.bed

Would it be possible to append the current STRling version number to the filename so that users can keep track of file versions down the track? For example:

hg19.STRchive-disease-loci.v2.0.2.TRGT.bed (open to format suggestions)

I'd also want to generate something similar for all the files, including json, to attach to the release. I've just been doing this manually. For example:
https://github.com/dashnowlab/STRchive/releases/tag/v1.2.0
Screenshot 2024-11-30 at 1 05 58 PM

@hdashnow hdashnow added enhancement New feature or request lower-priority Nice to have, but not urgent labels Nov 30, 2024
@hdashnow hdashnow changed the title Append STRchive version number to files downloaded from /loci/#downloads Append STRchive version number to files downloaded from /loci#downloads Nov 30, 2024
@vincerubinetti
Copy link
Contributor

vincerubinetti commented Dec 2, 2024

Partially closed by #100

As for the releases, for now you can continue to do it manually, but you can also write GitHub Actions workflows to automate releases. For example, we could have a workflow that runs any time a PR is merged into main, and if the version number in CITATION.cff is increased, we automatically create a new tag and release, and attach files (renamed to include version string).

As for file naming convention, I think these names are a bit hard to read, especially with the repeated use of periods. If someone were to try to write code to parse out the parts, it'd also be a challenge. If you're open to changing the file names, I'd recommend something like this:

STRchive-disease-loci_v1.2.0_hg19_TRGT.bed

So it's in order of increasing specificity... Starting with the project as a whole, then the project version, etc., with big "parts" always separated with underscores .

@hdashnow
Copy link
Member Author

hdashnow commented Dec 4, 2024

Looks great! That works for me. I'd definitely be interested in automating this in the future. Will keep this open as a reminder.

@vincerubinetti
Copy link
Contributor

vincerubinetti commented Dec 5, 2024

The remainder of the issue, the CI, has been added to #59 to be tracked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lower-priority Nice to have, but not urgent
Projects
None yet
Development

No branches or pull requests

2 participants