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

Archive Scheme and Create XCFramework workflows #40

Merged

Conversation

philippzagar
Copy link
Contributor

@philippzagar philippzagar commented Nov 8, 2023

Archive Scheme and Create XCFramework reusable workflows

♻️ Current situation & Problem

At the moment, the StanfordBDHG fork of llama.cpp as well as the fork of ResearchKit require a GitHub Actions workflow that archives a scheme and creates an XCFramework that is then published in a tagged release.
As both of these repositories need these functionalities, there is substantial code duplication.

⚙️ Release Notes

  • Add reusable GitHub Action workflows that archive a scheme and create an XCFramework.

📚 Documentation

Provided within the GitHub Action workflow files.

✅ Testing

Workflows have been tested manually.

Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@philippzagar philippzagar added the enhancement New feature or request label Nov 8, 2023
@philippzagar philippzagar self-assigned this Nov 8, 2023
@philippzagar philippzagar changed the title Archive and Create XCFramework workflows Archive Scheme and Create XCFramework workflows Nov 8, 2023
Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

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

Thank you for creating these reusable workflows!!

I had a few comments regarding the naming and reduction of input parameters that would be great to address before we merge it.

Thank you for taking care of this in ResearchKit and now llama++!

.github/workflows/archive.yml Outdated Show resolved Hide resolved
.github/workflows/archive.yml Outdated Show resolved Hide resolved
.github/workflows/archive.yml Outdated Show resolved Hide resolved
.github/workflows/archive.yml Outdated Show resolved Hide resolved
.github/workflows/xcframework.yml Outdated Show resolved Hide resolved
.github/workflows/xcframework.yml Outdated Show resolved Hide resolved
.github/workflows/xcframework.yml Outdated Show resolved Hide resolved
.github/workflows/xcframework.yml Outdated Show resolved Hide resolved
.github/workflows/xcframework.yml Outdated Show resolved Hide resolved
.github/workflows/archive.yml Outdated Show resolved Hide resolved
@philippzagar
Copy link
Contributor Author

@PSchmiedmayer Ready to review again!

Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

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

Looks great, thank you for the quick improvements! 🚀

@philippzagar philippzagar merged commit 1a1b116 into main Nov 9, 2023
2 checks passed
@philippzagar philippzagar deleted the feat/add-archive-and-xcframework-template-workflows branch November 9, 2023 05:24
@philippzagar philippzagar mentioned this pull request Nov 9, 2023
1 task
philippzagar added a commit that referenced this pull request Nov 9, 2023
# Fix nested reusable workflow

## ♻️ Current situation & Problem
The original PR #40
contained an issue that reusable workflows must specify the full path of
the nested reusable workflow in order to work properly. Furthermore, one
must pay attention to where the JSON decoding of the `runs-on` arguments
is done.


## ⚙️ Release Notes 
- Fixes an issue with the newly introduced XCFramework reusable workflow


## 📚 Documentation
--


## ✅ Testing
--


### Code of Conduct & Contributing Guidelines 

By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md):
- [X] I agree to follow the [Code of
Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md).

---------

Signed-off-by: Philipp Zagar <[email protected]>
philippzagar added a commit to StanfordBDHG/ResearchKit that referenced this pull request Nov 10, 2023
…ork (#9)

# Use template GitHub workflows for archiving and creating the
XCFramework

## ♻️ Current situation & Problem
In StanfordBDHG/.github#40, we introduced
reusable GitHub Actions workflows for the archiving and creation of
XCFrameworks. This enables us to avoid code duplication.


## ⚙️ Release Notes 
- GitHub Actions workflow utilizes shared reusable workflows.
- ResearchKit updated to latest version v2.2.12


## 📚 Documentation
Provided in the workflow files


## ✅ Testing
Manually tested by creating an example release of ResearchKit.


### Code of Conduct & Contributing Guidelines 

By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md):
- [X] I agree to follow the [Code of
Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md).

---------

Co-authored-by: Pariece McKinney <[email protected]>
Co-authored-by: philippzagar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants