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

Improve Badge & Add Basic GitHub Actions #4

Merged
merged 18 commits into from
Feb 18, 2024
Merged

Conversation

PSchmiedmayer
Copy link
Member

@PSchmiedmayer PSchmiedmayer commented Feb 16, 2024

Improve Badge & Add Basic GitHub Actions

♻️ Current situation & Problem

  • Badge does not link directly to the notebook
  • There is no check that the code conforms to the REUSE spec and no automated setup to execute the notebook
  • No initial CI setup

⚙️ Release Notes

README

  • Renamed the setup to Spezi Data Pipeline Template (same as for our other projects); the eventual tool will be named Spezi Data Pipeline once we have defined a good public API
  • Updated the Codepilot badge to open the notebook without even having to select something.

REUSE & Markdown Testing

  • Added GitHub Actions to test the REUSE Spec conformance & ensure that we properly license everything. 
  • Added a test that checks that links in the markdown are all correct and don’t return a 404.

CI & Testing

📝 Code of Conduct & Contributing Guidelines

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

@PSchmiedmayer PSchmiedmayer added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 16, 2024
@PSchmiedmayer PSchmiedmayer self-assigned this Feb 16, 2024
@PSchmiedmayer PSchmiedmayer merged commit 51e212a into main Feb 18, 2024
2 of 3 checks passed
@PSchmiedmayer PSchmiedmayer deleted the improveBadge branch February 18, 2024 22:37
Vicbi pushed a commit that referenced this pull request Feb 28, 2024
- Badge does not link directly to the notebook
- There is no check that the code conforms to the REUSE spec and no automated setup to execute the notebook
- No initial CI setup

* Renamed the setup to Spezi Data Pipeline Template (same as for our other projects); the eventual tool will be named Spezi Data Pipeline once we have defined a good public API
* Updated the Codepilot badge to open the notebook without even having to select something.

* Added GitHub Actions to test the REUSE Spec conformance & ensure that we properly license everything. 
* Added a test that checks that links in the markdown are all correct and don’t return a 404.

* Added a setup that boots up the Firebase Emulator to do testing and run the notebook in the CI without accessing a production Firebase project. It allows us to export and import a set of mock data for testing purposes, which would be great to e.g., test the notebook in the CI: https://firebase.google.com/docs/emulator-suite/connect_firestore#import_and_export_data. See #5 for more detail.

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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants