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 run release tests on liboqs release candidates #345

Merged
merged 6 commits into from
Feb 2, 2024

Conversation

SWilson4
Copy link
Member

@SWilson4 SWilson4 commented Feb 1, 2024

This PR proposes a release test workflow which can be triggered by repository_dispatch events. For example, with a corresponding PR in liboqs, we could trigger these workflows to run automatically on release candidates.

For a proof-of-concept, see https://github.com/SWilson4/cicd-playground-upstream and https://github.com/SWilson4/cicd-playground-downstream.

Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

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

Thanks for this proposal: Smart. Conceptually LGTM/I get the logic -- but the changes in release-test.sh appear to prohibit the use of the script standalone (wreaking havoc on the local github setup). But then again, this CI logic should eliminate the need/desire to run the script locally, so I think I'd be OK with the if/when you mark it Ready for Review -- assuming we also activate the matching upstream trigger-logic so this is always done during release.

@SWilson4
Copy link
Member Author

SWilson4 commented Feb 1, 2024

Thanks for this proposal: Smart. Conceptually LGTM/I get the logic -- but the changes in release-test.sh appear to prohibit the use of the script standalone (wreaking havoc on the local github setup). But then again, this CI logic should eliminate the need/desire to run the script locally, so I think I'd be OK with the if/when you mark it Ready for Review -- assuming we also activate the matching upstream trigger-logic so this is always done during release.

I've renamed the script release-test-ci.sh and added a wrapper around it in release-test.sh so it can be used locally, just in case.

@SWilson4
Copy link
Member Author

SWilson4 commented Feb 1, 2024

Upstream PR to trigger this: open-quantum-safe/liboqs#1654.

@SWilson4 SWilson4 requested a review from baentsch February 1, 2024 22:55
@SWilson4 SWilson4 marked this pull request as ready for review February 1, 2024 22:56
Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

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

Very nice logic -- particularly the local execution wrapper: Thanks!

@baentsch baentsch merged commit 24f98e8 into main Feb 2, 2024
1 check passed
@baentsch baentsch deleted the sw-automate-release-tests branch February 2, 2024 16:53
@SWilson4
Copy link
Member Author

SWilson4 commented Feb 5, 2024

@baentsch I've edited the wiki to reflect the now (hopefully) streamlined release process. Please take a look and make any edits you see fit :)

@baentsch
Copy link
Member

baentsch commented Feb 6, 2024

I've edited the wiki

Perfect. Should the "...-tracker mechanism" turn out to work well, we may also change wording in https://github.com/open-quantum-safe/liboqs/blob/main/.github/pull_request_template.md (demanding such branches to be present in relevant subprojects).

feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 13, 2024
…safe#345)

* Add CI job for triggering downstream tests, e.g., during releases

* Add wrapper around CI script for local use

* Generalize workflow so that the provider ref can be specified

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 16, 2024
…safe#345)

* Add CI job for triggering downstream tests, e.g., during releases

* Add wrapper around CI script for local use

* Generalize workflow so that the provider ref can be specified

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
…safe#345)

* Add CI job for triggering downstream tests, e.g., during releases

* Add wrapper around CI script for local use

* Generalize workflow so that the provider ref can be specified

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
…safe#345)

* Add CI job for triggering downstream tests, e.g., during releases

* Add wrapper around CI script for local use

* Generalize workflow so that the provider ref can be specified

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
…safe#345)

* Add CI job for triggering downstream tests, e.g., during releases

* Add wrapper around CI script for local use

* Generalize workflow so that the provider ref can be specified

Signed-off-by: Felipe Ventura <[email protected]>
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