Is there a cross-platform Aminet readme generator script?

5 posts / 0 new
Last post
Hans
Hans's picture
Offline
Last seen: 1 day 10 hours ago
Joined: 2010-12-09 22:04
Is there a cross-platform Aminet readme generator script?

I'm looking at automating the ZitaFTP release process a bit more, and also uploading it to the aminet. Has anyone written a script/tool to help generate aminet readme's? Preferably a bash/python script, or something else that's cross platform.

Ideally, here's how it would work:
- There's a template with the basic info that doesn't change (e.g., name, brief description). Or, it could be stored in a JSON file (or similar)
- The script would update the version number by reading the current version number from the program (or the *.lha archive name, which has the form
_.lha
- The script would extract the latest changes from "Release Notes.txt," pulling out the changes since the last upload
- Bonus: upload the archive and readme to aminet (e.g., using curl)

With small tweaks, the same script could be used to upload to os4depot as well. It has a similar upload process to aminet, but slightly different readme requirements.

Hans

Steady
Steady's picture
Offline
Last seen: 1 week 5 days ago
Joined: 2011-07-18 05:02
Re: Is there a cross-platform Aminet readme generator script?

I think Report+ from James Jacobs has that functionality in it.

Hans
Hans's picture
Offline
Last seen: 1 day 10 hours ago
Joined: 2010-12-09 22:04
Re: Is there a cross-platform Aminet readme generator script?

@Steady

True, but it's not cross-platform, nor can you use it to auto-generate readme's from a script.

Hans

http://hdrlab.org.nz/ - Amiga OS 4 projects, programming articles and more. Home of the RadeonHD driver for Amiga OS 4.x project. http://keasigmadelta.co.nz/ - more of my software.
walkero
walkero's picture
Offline
Last seen: 3 days 44 min ago
Joined: 2009-05-03 16:54
Re: Is there a cross-platform Aminet readme generator script?

@Hans
What I am doing with my aiostreams CI/CD, where I automatically deploy a release to both Aminet and os4depot, is to use sed to change a placeholder in the readme templates

For now, I do it on os4depot.readme file (https://github.com/walkero-gr/aiostreams/blob/master/os4depot.readme) where I set on release the OS4DEPOT_PASSPHRASE from a secret variable I have in the CI/CD platform I use

You can see how I do the replacement at:
https://github.com/walkero-gr/aiostreams/blob/master/.drone.yml#L106

and then I upload the release file and the readme, using FTP, to os4depot. The same way could be done to change automatically the version, although that's something I haven't done yet.

- The script would update the version number by reading the current version number from the program (or the *.lha archive name, which has the form
_.lha

That release job is initiated when I create a new git tag, where I set the release version. So, this can be used as the version string inside the files. By doing that, you don't need to get the version anywhere else.

- The script would extract the latest changes from "Release Notes.txt," pulling out the changes since the last upload

That is possible to be done with bash script/line, which can put it again with sed into the readme template. I do not have something like that right now to show you.

- Bonus: upload the archive and readme to Aminet (e.g., using curl)

The CI/CD platform I use is based on docker almost completely. So I use docker containers to do the FTP upload. I think that any CI/CD platform that supports docker containers, and most of them do, can use the same images as the ones I use.

At https://github.com/walkero-gr/aiostreams/blob/master/.drone.yml#L80-L96 I prepare the Aminet release and do the upload, and at https://github.com/walkero-gr/aiostreams/blob/master/.drone.yml#L97-L117 I do the same for os4depot. This works fine everytime.

Hans
Hans's picture
Offline
Last seen: 1 day 10 hours ago
Joined: 2010-12-09 22:04
Re: Is there a cross-platform Aminet readme generator script?

@walkero

Thanks. I'll check out your scripts.

Hans

http://hdrlab.org.nz/ - Amiga OS 4 projects, programming articles and more. Home of the RadeonHD driver for Amiga OS 4.x project. http://keasigmadelta.co.nz/ - more of my software.
Log in or register to post comments