Skip to content

Commit

Permalink
Reviewer's updates
Browse files Browse the repository at this point in the history
  • Loading branch information
agnieszka-m committed Dec 12, 2024
1 parent c4eae2f commit 1522474
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Deepset Cloud 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:
Expand All @@ -21,7 +21,7 @@ See also our tutorial for [creating a custom RegexBooster component](https://doc
- Python v3.10 or v3.11
- `hatch` package manager

### Hatch: A Python Package Manager
### Hatch: A Python package manager

We use `hatch` to manage our Python packages. Install it with pip:

Expand Down Expand Up @@ -68,7 +68,7 @@ components:
...

```
### Working on Your Component
### Working on your component

1. Fork this repository.
2. Navigate to the `/src/dc_custom_component/components/` folder.
Expand Down Expand Up @@ -96,9 +96,10 @@ You can upload in one of two ways:
- By releasing your forked directory.
- By zipping the forked repository and uploading it with commands.

### Uploading by Releasing Your Forked Repository
### Uploading by releasing your forked repository

We use GitHub Actions to build and push custom components to deepset Cloud. The action runs the tests and code quality checks before pushing the component code to deepset Cloud. Create a tag to trigger the build and the push job. This method helps you keep track of the changes and investigate the code deployed to deepset Cloud.

We use GitHub Actions to build and push custom components to deepset Cloud. The action runs the tests and code quality checks before pushing the component code to deepset Cloud. Create a tag to trigger the build and the push job.
After forking or cloning this repository:

1. Push all your changes to the forked repository.
Expand All @@ -112,7 +113,7 @@ After forking or cloning this repository:
You can check the upload status in the `Actions` tab of your forked repository.

### Uploading a Zipped Repository with Commands
### Uploading a zipped repository with commands

In this method, you run commands to zip and push the repository to deepset Cloud.

Expand Down

0 comments on commit 1522474

Please sign in to comment.