nichollsh / SOCRATES

Redistributed on GitHub from the original TRAC repository, with modifications and additions.
https://code.metoffice.gov.uk/trac/socrates
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Make SOCRATES available via github artifacts #6

Closed stefsmeets closed 1 month ago

stefsmeets commented 1 month ago

This PR zips up the build for SOCRATES and makes it available via Github artifacts.

The automated releases work like this:

The action will build the package anyway and make them available at the actions page: https://github.com/nichollsh/SOCRATES/actions/runs/10182560102 Only a tagged version gets released.

TODO

stefsmeets commented 1 month ago

Not too fast, I want to make sure that it works 😁

stefsmeets commented 1 month ago

Could you approve the workflow and/or give me write access so that I can test/debug it myself? https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks

nichollsh commented 1 month ago

I have invited you to become a Collaborator on this repository, which I believe should provide the permissions.

stefsmeets commented 1 month ago

@nichollsh Let me know if you are happy with this. Once this is merged we should test the automated release by pushing a tag to main. Do you have a place we could document this workflow?

nichollsh commented 1 month ago

Makes sense - I am happy with this, although I suppose we can only find out if it works when a tag is created.

The SOCRATES documentation is historically a simple PDF file, so there's no "official" place to document this. The only documentation I have added is in spectraltools as a text file.

For now, we could make a text file in the .github folder to explain what the workflow is doing, and then discuss how to better handle SOCRATES documentation. I do think a more robust unofficial documentation for SOCRATES would be useful, which could come in the form of a GitHub pages wiki, which would be consistent with what AGNI does, and what I believe also with what mkdocs will do for the other repositories.

stefsmeets commented 1 month ago

Fair enough, I added a small readme with some details. I'm fine with merging this, then we can test a bit how it works. I see that the PR is against your fork, and not the FormingWorlds fork, so it would be good to update that and make a release there (or wherever is the preferred place).

We can tweak it later, one of the things I would like to test is if we can trigger the workflow from Github releases directly, provided we change the trigger for the worflow to run on release. This should then update the release with the build zip. This is also how builds from multiple OS's can be supported, eventually.