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

data/doc/ isn't present in the 1.0.0 release tarball #926

Closed
trebmuh opened this issue Aug 15, 2020 · 9 comments
Closed

data/doc/ isn't present in the 1.0.0 release tarball #926

trebmuh opened this issue Aug 15, 2020 · 9 comments
Assignees

Comments

@trebmuh
Copy link
Member

trebmuh commented Aug 15, 2020

This is quite annoying for distribution purpose.

In https://github.com/hydrogen-music/hydrogen/releases/tag/1.0.0 , the https://github.com/hydrogen-music/hydrogen/archive/1.0.0.tar.gz doesn't contains the data/doc/ subfolder probably because it's a GIT submodule and the assets doesn't add it automatically.

This leads distributions such as Debian (and probably others) to not distribute the doc with the software.

I strongly suggest to release shortly a 1.0.1 with a .tar.gz assets including the data/doc/ module.

@mauser
Copy link
Member

mauser commented Aug 17, 2020

Will be fixed with the next patch release..

@trebmuh
Copy link
Member Author

trebmuh commented Sep 3, 2020

As I can see you're releasing a point version right now, I'm wildly pinging you here lord @mauser !

@mauser
Copy link
Member

mauser commented Sep 3, 2020

There is no way to put the content of the doc submodule in the generated tarballs by Github. This is a requested feature, but it does not seem possible at the moment. I will put a note on the release page and put the "enhanced" tarballs on SF. The Windows and Mac installers are fixed, they are shipped with the documentation.

@trebmuh
Copy link
Member Author

trebmuh commented Sep 3, 2020

@mauser , you can attach any asset you want, see (the "sfizz-0.4.0-src.tar.gz" asset in) sfizz as an example. The tarball needs either to be manually build and then uploaded to github, or maybe there is a possibility to have a github-hook to build it, I don't know.

@mauser
Copy link
Member

mauser commented Sep 3, 2020

The problem is that i can't remove the automatically created tarballs from Github, which do not include the doc files. I've added an additional tarball to the release, SF includes now only the "fixed" tarball.

@mauser mauser closed this as completed Sep 3, 2020
@trebmuh
Copy link
Member Author

trebmuh commented Sep 3, 2020

The problem is that i can't remove the automatically created tarballs from Github, which do not include the doc files.

Yes, I know, this is very not optimal from github.

I've added an additional tarball to the release, SF includes now only the "fixed" tarball.

Awesome 👍 Hopefully distro will get it right. Great idea for the "attention" note. I've put in in bold and added a parenthesis to stress the "packager point of view". Hope this is fine for you.

@trebmuh
Copy link
Member Author

trebmuh commented Sep 4, 2020

Hi @mauser it looks like there are only the html files in the tarball's data/doc (in contrast with https://github.com/hydrogen-music/documentation where there are a lot of other files). Is that done on purpose?

@mauser
Copy link
Member

mauser commented Sep 4, 2020

The tarball includes the generated documentation for 1.0. The other files are the source files of the documentation, so in my opinion they are not needed in the tarball. For development purposes, you need the git repo, not the tarball.

@trebmuh
Copy link
Member Author

trebmuh commented Sep 4, 2020

OK, makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants