Implement CI/Testing Setup (Unverified commit blocked merge) #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…pelineTemplate into addCITestSetUp
PSchmiedmayer
requested changes
Feb 27, 2024
There was a problem hiding this comment.
Thank you for creating the PR @Vicbi!
I had some first comments; lets use our meeting today to discuss them in more detail 👍
1 task
Vicbi
changed the title
Vicbi
added a commit
that referenced
this pull request
Feb 28, 2024
# Implement CI/Testing Setup and Update README Requirements ## ♻️ Current situation & Problem This PR aims to sign off a previous commit (7abc6a8) which was not signed at the time of submission. This is required for merging PR #8 . ## ⚙️ Release Notes Signed off previous commit 7abc6a8. ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: Paul Schmiedmayer <PSchmiedmayer@users.noreply.github.com>
Vicbi
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implement CI/Testing Setup and Update README Requirements
♻️ Current situation & Problem
This PR addresses two open issues:
Issue #5: Lack of CI and testing setup leading to build-breaking changes.
Issue #6: Discrepancies between GitHub Actions requirements and README documentation.
⚙️ Release Notes
Introduced a CI/testing setup using GitHub Actions, Firebase Emulator, and nbconvert for executing notebooks within CI, ensuring full integration tests without accessing production Firebase projects.
Updated README to include all necessary installation requirements matching the GitHub Actions setup.
Examples:
firebase emulators:exec --import=./sample_data "jupyter nbconvert --to pdf --execute SpeziDataPipelineTemplate.ipynb"📚 Documentation
Enhanced in-line documentation within the GitHub Actions workflow files to explain the purpose and function of each step in the CI process.
Added instructions in the README to guide through the installation of project dependencies including requests, ipywidgets, and pytz, mirroring the setup in Google Colab.
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: