Fixed problems with Release Workflow Automation

[ColinHDev]

Summary of the discussion

During the release of v2.6.0 and the therefor testing of the in #1956 introduced release workflow automation, multiple errors were noticed:

• The jobs responsible for generating the artifacts for the release, ran concurrently with the job responsible for uploading those artifacts. This results in no artifacts being uploaded, as they haven't been built at that time.
  • This PR fixes this by ensuring the job responsible for uploading the artifacts can only run after the ones generating them are finished.
• The build-files.zip artifact contained the oeo folder twice instead of having the required structure of build-files/oeo/[version]/.
  • This should no longer be the case.
• If the person creating the release provided release notes or set the release as draft or pre-release, this workflow would wrongly undo those changes when attaching the artifacts, making the release non-draft and non-pre-release, as well removing the release notes.
  • This is no longer case, the release name, body as well as draft and pre-release state are no longer updated when attaching the artifacts.
  • If the workflow runs on a "normal" release (not draft, not pre-release), it will also no longer be automatically marked as "latest" based on the version number. Instead this has to be set manually as well.

Due to being unable to properly test these changes, they have to be properly verified again at the next release.

Type of change (CHANGELOG.md)

---

Workflow checklist

Automation

Closes #

PR-Assignee

• 🐙 Follow the Pull Request Workflow
• 📝 Update the CHANGELOG.md
• 📙 Add #'s to term tracker annotation

Reviewer

• 🐙 Follow the Reviewer Guide
• 🐙 Provided feedback and show sufficient appreciation for the work done

[ColinHDev]

The current release workflow How to Release a New Ontology Version would have to be adapted to include the following:

1. Create a release (ideally as draft / prerelease?)
   • Define the name and body containing the release notes
2. Wait for the workflow to complete
   • The status of the run can always be found here: https://github.com/OpenEnergyPlatform/ontology/actions/workflows/PostReleaseScripts.yml
   • This should take around 10min
3. Review the workflow files and check whether they have the correct file structure
4. Update the release status:
   • It shouldn't be a draft. (A draft release indicates an "unfinished" release. They are only visible to maintainers.)
   • It probably shouldn't be a pre-release. (A pre-release generally indicates that the published version might be unstable and shouldn't be used in production. They are visible to everyone.)
   • It probably should be the latest. (Marking a release as "latest" indicates that this release contains the most recent version.)

But we could also discuss the following:

• Currently, the workflow runs for any releases created. However, it could also be adapted to run only if a draft or pre-release is created. This way, the wiki could mention Only if you create your release as a draft, build files will be automatically attached to the draft. If you create a normal release, you can skip this behaviour.
• The workflow could also be adapted to change the release state from draft to normal / latest automatically, this way no maintainer has to manually edit the release again after waiting for the workflow to finish attaching the files.

[stap-m]

Thanks for fixing this!

I think, the workflow is needed with any release.

The workflow could also be adapted to change the release state from draft to normal / latest automatically, this way no maintainer has to manually edit the release again after waiting for the workflow to finish attaching the files.

Ok, lets keep that in mind. If it works out well for the next release, we can think about that in a next step to ease the process.

Did you already update the description in the wiki @ColinHDev or @madbkr ?

[ColinHDev]

Did you already update the description in the wiki @ColinHDev or @madbkr ?

Yes, this is the current version:

which can be found here: https://github.com/OpenEnergyPlatform/ontology/wiki/How-to-release-a-new-ontology-version