Could this project be versioned somehow?

FelixFrog / pdfgrabber

Download PDF books from bSmart, Pearson, Oxford, and many more!

GNU Affero General Public License v3.0

109 stars 15 forks source link

Could this project be versioned somehow? #65

Open BigB84 opened 9 months ago

BigB84 commented 9 months ago

Hi!

Once again thanks so much for this project!

I want to ask / start discussion whether this project could be versioned somehow/

It's just easier to package it for some distro especially that -git packages that could be found in AUR are not always accepted. Also it may be helpful with bug reporting.

What do you think about below exmaple pipeline:

master and development branch where master is always stable (gives no error) and dev has all bells and whistles (for example not tested recent fixes)
Unit tests and CI/CD that checks if pushed code returns no error on dev branch that gives clear information about code state
when code gets stable rebase to the master branch
some other CI/CD on master branch polishing, linting, code coverage etc.
then tag/release from master branch

What do you think?

FelixFrog commented 9 months ago

Hi! Thanks for the contribution. pdfgrabber is sadly much more akin to something like yt-dlp than to a normal program. What I mean by that is that the only real version of the software that should work is the git HEAD. What versioning could fix though is the dependency situation. So for example there could be a release tag that is targeted towards a specific python, pymupdf, playwright, chromium, ecc... versions. Since major updates to service downloaders are not that frequent, it wouldn't justify a whole different release branch just for testing. As of now the project is still very small and I'm able to manage it without much help, so CI/CD integration seems overkill for now (maybe in the future when it's much bigger ;-) Versioning is definitely an idea though, and I reckon a good one. About packaging it in the AUR, I am not very experienced with python-based PKGBUILDs, so once we have figured a versioning system out it could be very interesting to pull off.

BigB84 commented 9 months ago

Cool! As you wish ;)

Eventually would you accept some PR for CI/CD in the future for specific tasks? Mostly unit-testing or wheel building?

So what are the current blockers to make it released?

FelixFrog commented 9 months ago

Yes, every PR/contribution is welcomed! As of now the only thing holding me back from releasing a proper version is some final touches and deciding on minimum/required versions for python and dependecies. Ideally I would like to make it run on python 3.8 (since I think it's the version still packaged in some ubuntu/debian stable releases).