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

Please "git tag" your RAKU modules with it's versions #37

Open
AntonOks opened this issue Apr 26, 2023 · 10 comments
Open

Please "git tag" your RAKU modules with it's versions #37

AntonOks opened this issue Apr 26, 2023 · 10 comments

Comments

@AntonOks
Copy link

Can you please "GIT TAG" your RAKU modules with it's version, similar and at the same time you maintain it's "version": "x.y.z" in your META6.json file?

I was told, this will happen "for free" going forward with mi6 anyhow, but for now it would be great if you spend those 2 seconds already now :)

"Tagging" is generally highly appreciated in regards to "reproducible builds" and here especially for the "Rakudo Star" modules

THANK YOU!

@JJ
Copy link
Contributor

JJ commented Apr 27, 2023

In this case, I think you're better off dropping it from Rakudo Star. I don't even think this is functional.

@AntonOks
Copy link
Author

well, at least it's installed with Star on my Win10 and UBUNTU box'es :)
and it also still creates some HTML files ;) ... but yes, also printing errors...

if you say, it's unmaintained and broken, I'd remove it from Star, hoping no one uses / requires it anyhow...

@JJ
Copy link
Contributor

JJ commented Apr 28, 2023

Don't really think anyone does. It's not been working for the last 4 years or so... We'd probably do best to archive this repo, too

@finanalyst
Copy link
Contributor

This Pod renderer used a different approach than Pod::To::HTML. It is the same approach I use in Raku::Pod::Render.
This module's main benefit is to generate a single HTML page from all Rakudoc documents, which can then be incorporated into an epub book.
There is an issue to create an epub in the Raku/doc-website repo, which I hope to do in due course.
Consequently, this module is almost completely superseded now.

@AntonOks
Copy link
Author

That's all valuable feedback, thanks.
I have no idea who added this module when and, even more, if if is used somewhere or not and if "Star" dependencies for someone would break if I / we remove it...

Can someone with "push / write permissions" please "git tag f2daefe" and then "git push --tags" nevertheless now until somehow someone can review which modules should still be included in Star? This would still add to "reproducible build" in general and be better to what there is now...

"Worst case", feel free to give me the permissions on this repo and I will "tag" it...

@finanalyst
Copy link
Contributor

I think @tbrowder either wrote the module or knows who did. Alternatively, @moritz might know.

@finanalyst
Copy link
Contributor

@AntonOks It is possible that my Raku::Pod::Render and Collection modules should be considered for inclusion into Star as the new raku website uses them.

@AntonOks
Copy link
Author

@AntonOks It is possible that my Raku::Pod::Render and Collection modules should be considered for inclusion into Star as the new raku website uses them.

@finanalyst - THANKS for you suggestion!, sounds good to me.

I'd suggest, you add "your" modules and send a pull request for "Rakudo Star" modules so it would be "documented" in the git history who included this modules when...

is this "ok" for you?

@AntonOks
Copy link
Author

AntonOks commented Apr 30, 2023

btw., just had a look... seems like your Raku::Pod::Render requires node or npm... and from my understanding, a RAKUDO module, which has dependencies on other external tools, which are not guaranteed to be installed at the time the Star modules are installed, is not really making sense... because at the end, you never know which modules where installed secessfully on which system... and pls remember, Rakudo Star is build for Windows, Linux* and macOs... so all modules should "just work" on all those OSes and be kind of "reproducible"

@finanalyst
Copy link
Contributor

node / npm are required only to get highlighting. This is also true of Documentable and the tooling that used to be required for creating the Raku Documentation site.

It is a dependency that is being discussed as to whether to get rid of it.

It is possible - in principle - to install Raku::Pod::Render without npm, in which case there is no highlighting. In fact, I think that if npm is not available, there should be a note and the Module will work without it.

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

No branches or pull requests

3 participants