Skip to content

Conversation

@b-s-code
Copy link
Collaborator

@b-s-code b-s-code commented Jul 11, 2025

Problem

The description on the GitHub Release page for OpenMalaria was being overwritten with "OpenMalaria build for Windows". This text is meant to pertain to the whole release - for all platforms.

Solution

Removing the Description tag from appveyor should be enough to prevent appveyor from overwriting the release text.

The github action generated text has been updated with a link to Docker images and XSD documentation.
The links should automatically point to the right version of the file using the ${{ github.ref_name }} variable.

The | symbol is for a multiline YAML comment.

b-s-code and others added 2 commits July 11, 2025 16:24
The description on the GitHub Release page for OpenMalaria was being
overwritten with "OpenMalaria build for Windows".  This text is meant to
pertain to the whole release - for all platforms.
@acavelan
Copy link
Collaborator

It needs testing!

@b-s-code
Copy link
Collaborator Author

b-s-code commented Sep 8, 2025

I've pushed a tag in my fork to test these changes.
https://github.com/b-s-code/openmalaria/releases/tag/schema-test_new_build

The last couple links in the release text are broken, which is fair enough because I just made a dummy tag in my fork.

Example scenario: https://github.com/SwissTPH/openmalaria/blob/schema-test_new_build/util/example/example_scenario.xml
XSD documentation: https://swisstph.github.io/openmalaria/schema-test_new_build.html

I'm waiting to see if the release text is preserved after the appveyor build finishes.

Then I'll follow up.

@b-s-code
Copy link
Collaborator Author

Following up: the AppVeyor build didn't overwrite the release text which is good. But now the Windows build doesn't appear at all on the release page, even though it succeeded. I'll have to look into it.

@b-s-code
Copy link
Collaborator Author

I tested whether changes in this PR caused the Windows build not to get uploaded to the Releases page.

The changes in this PR do not appear to be responsible for that - here is my build without this PR's changes https://github.com/b-s-code/openmalaria/releases/tag/schema-test_2025-09-10_no_workflow_changes the Windows build is still absent.

My current hypothesis is that the macOS builds failing might be causing this.

GitHub appears to have fixed that underlying issue now so I'm going to re-run the above test and see if I get different results.

Will follow up.

@acavelan
Copy link
Collaborator

Tested in my forked repository: https://github.com/acavelan/openmalaria/releases/tag/schema-47.0-test

  • It uploaded the artifact to the release
  • It did not update the description, as expected

@b-s-code
Copy link
Collaborator Author

Cheers for testing in your fork @acavelan

I've since merged latest changes from main into this branch and I think I should repeat the testing, since the relevant files changed on main.

CI results are all good but I'd like to check the actual release automation functionality.

Easiest way for me to run this test is to merge this PR to main and then make a dummy release, which I would delete once I've confirmed:

  • all release artifacts are present in the release, and
  • release text looks good.

This would save me mucking around with AppVeyor tokens.

If that sounds alright, please approve and I'll go ahead, otherwise lmk if any concerns.

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

Successfully merging this pull request may close these issues.

2 participants