Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically attach the required files to releases #1956

Merged
merged 1 commit into from
Nov 3, 2024

Conversation

ColinHDev
Copy link
Member

@ColinHDev ColinHDev commented Oct 20, 2024

Summary of the discussion

As described in #1955, the Release workflow currently requires that an oeo-closure.owl file present in the build-files.zip artifact to be attached to a release. However that pull request would remove said file from the artifacts for a reduced completion time of workflow runs.

This Pr tries to automate the release workflow. Instead of a maintainer going to the workflow artifacts of two separate runs to download the build-files.zip and existing-terms-and-definitions.zip and create a release with them, the maintainer would now only have to write and publish the release and this workflow would then automatically attach said files.

However, I am not really able to test this easily. But even if the automation fails, this pr ensures that a version of build-files.zip is uploaded that contains the oeo-closure.zip file, so the maintainer can add it automatically.

Type of change (CHANGELOG.md)

---

Workflow checklist

Automation

Closes #

PR-Assignee

Reviewer

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

@ColinHDev ColinHDev requested a review from stap-m October 20, 2024 23:04
@stap-m stap-m requested a review from jh-RLI October 21, 2024 06:37
@stap-m
Copy link
Contributor

stap-m commented Oct 21, 2024

@jh-RLI could you please also take a look at this PR?

@stap-m
Copy link
Contributor

stap-m commented Oct 28, 2024

Looks good to me. However, I don't get every single command...
@jh-RLI could you please also review with respect to OpenEnergyPlatform/oeplatform#1791

Copy link

@jh-RLI jh-RLI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, sorry for the late response. This looks very promising. Maybe for the next release you could do a "vX.X.X-pre" release to test this workflow? From looking at the workflow file, everything seems correct. The resulting artifacts should be reviewed at least once.

For the OpenEnergyPlatform it is important to have at least the structure & files available that are also in the current build-files.zip for v2.5.0. If something changes, let me know. The OEP attempts to read the files / provides them for download.

@ColinHDev
Copy link
Member Author

Hi, sorry for the late response. This looks very promising. Maybe for the next release you could do a "vX.X.X-pre" release to test this workflow? From looking at the workflow file, everything seems correct. The resulting artifacts should be reviewed at least once.

For the OpenEnergyPlatform it is important to have at least the structure & files available that are also in the current build-files.zip for v2.5.0. If something changes, let me know. The OEP attempts to read the files / provides them for download.

The file structure should be the same, as I took the steps that build them from the other workflow. But checking whether everything is correct with a pre-release is definitely the best approach!

However, there will be a delay of about 10 to 15 minutes before the files are built. Previously, the person writing the release just had to download the files and attach them to the release, making them available at the same time the release was published. Now, the files first have to be built which is only triggered after the release is published.
But I don't know whether that needs to be considered for the OEP.

@ColinHDev ColinHDev merged commit a205eff into dev Nov 3, 2024
4 checks passed
@ColinHDev ColinHDev deleted the feature-automatic-release-file-attaching branch November 3, 2024 21:46
@jh-RLI
Copy link

jh-RLI commented Nov 4, 2024

Thanks @ColinHDev for the hint. This is not a problem, currently the OEO version in OEP has to be updated manually as well, as we can't really communicate with Github via the OEP web server for security reasons. As there is no timeing dependent process implemented that fails if the files are only available some time after release, this is not an issue that is currently bothering us :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants