-
Notifications
You must be signed in to change notification settings - Fork 17
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
feat: integrate with gh #17
Open
ArzelaAscoIi
wants to merge
4
commits into
main
Choose a base branch
from
feat/integrateWithGH
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: Build and Push Custom Component | ||
|
||
on: | ||
push: | ||
tags: | ||
- '*.*.*' | ||
|
||
jobs: | ||
build-and-push: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.12' | ||
|
||
- name: Install dependencies | ||
run: | | ||
pip install hatch | ||
|
||
- name: Set version | ||
run: | | ||
VERSION=${GITHUB_REF#refs/tags/} | ||
hatch version $VERSION | ||
|
||
- name: Build and push | ||
env: | ||
API_KEY: ${{ secrets.DEEPSET_CLOUD_API_KEY }} # Make sure to add this secret to your repository | ||
run: hatch run dc:build-and-push |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# dc-custom-component-template | ||
# Deepset Cloud Custom Component Template | ||
|
||
This repository contains a template for creating custom components for your deepset Cloud pipelines. Components are Python code snippets that perform specific tasks within your pipeline. This template will guide you through all the necessary elements your custom component must include. | ||
This template contains two sample components which are ready to be used: | ||
|
@@ -96,3 +96,15 @@ It's crucial to thoroughly test your custom component before uploading it to dee | |
This creates a zip file called `custom_component.zip` in the `dist` directory and uploads it to deepset Cloud. | ||
|
||
For detailed instructions, refer to our documentation on [Creating a Custom Component](https://docs.cloud.deepset.ai/docs/create-a-custom-component). | ||
|
||
### GitHub Actions | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @agnieszka-m can you please help us out here to make the instructions for the user clearer? |
||
|
||
We use GitHub Actions to build and push the custom component to deepset Cloud. When you create a tag, the build and push job will be triggered. | ||
After forking/cloning this repository, you need to | ||
|
||
1. add the following [secrets to your repository](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions): | ||
- `DEEPSET_CLOUD_API_KEY`: Your deepset Cloud API key (repo > settings > secrets and variables > actions > new repository secret) | ||
2. (Optional) adjust the workflow file to your needs in `.github/workflows/publish_on_tag.yaml` | ||
3. When creating a tag, the workflow will build and push the custom component to deepset Cloud with the tag as version. | ||
|
||
> **Warning:** When using this GitHub Actions workflow, the version specified in the `__about__` file will be overwritten by the tag value. Make sure to use appropriate tag values that correspond to your desired version numbers. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥 Let's also add a testing step in the CI + documentation (e.g. how to trigger, where to put API key etc.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ArzelaAscoIi How about also adding a flow
on: pullrequest
which runs the linting + testing steps?