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

Create a formal release for distribution #3

Open
k8hertweck opened this issue Sep 17, 2021 · 5 comments
Open

Create a formal release for distribution #3

k8hertweck opened this issue Sep 17, 2021 · 5 comments
Labels
high priority to be completed before next release

Comments

@k8hertweck
Copy link
Member

I recommend packaging this software as a release, since we'll be able to track the number of downloads using the GitHub API. This will make it easier to track people using the package as-is (without customization). The alternative is to suggest people download using the "download zip" feature on the main page of the repo. Although this works, we won't be able to track it. Releases also provide a nice way to vaguely track usage of new features, community contributions, etc.

I think the first release at the end of September would work well being labeled as a beta release, indicating it's part of the pilot.

@ergonyc
Copy link
Member

ergonyc commented Sep 18, 2021

This makes sense. What do we need to do besides:

  • create the .zip / release
  • update the "installation" instructions to download release over devtools::install_github("ergonyc/omicser")

@ergonyc
Copy link
Member

ergonyc commented Sep 20, 2021

Created a "pre-release" v0.1-alpha. Note that the documentation still refers to a devtools::install_github installation.
https://github.com/ergonyc/omicser/releases/tag/v0.1-alpha
. DELETED release.

@k8hertweck
Copy link
Member Author

Crap, I didn't think about the interaction between the releases and installation. I'll research this a bit more

@k8hertweck k8hertweck added the high priority to be completed before next release label Sep 20, 2021
@k8hertweck
Copy link
Member Author

Looks like there isn't a straightforward way to use devtools for installation while also tracking downloads. I'll note this in my assessment strategy.

@ergonyc
Copy link
Member

ergonyc commented Sep 27, 2021

I removed the v0.1-alpha release due to it being old/buggy and we have not followed good "release" hygene. Need to revisit install instructions (@k8hertweck )and alpha-release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
high priority to be completed before next release
Projects
None yet
Development

No branches or pull requests

2 participants