Skip to content

Commit

Permalink
chore: update README and workflow [docs]
Browse files Browse the repository at this point in the history
  • Loading branch information
yasinmiran committed Oct 10, 2024
1 parent e27a2a3 commit adcd3d8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/publish-docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ permissions:

jobs:
bump_version:
if: "!contains(github.event.head_commit.message, '[docs]')"
runs-on: ubuntu-latest
outputs:
version: ${{ steps.extract_version.outputs.version }}
Expand Down Expand Up @@ -54,6 +55,7 @@ jobs:
echo "version=$VERSION" >> "$GITHUB_OUTPUT"
build_and_push:
if: "!contains(github.event.head_commit.message, '[docs]')"
runs-on: ubuntu-latest
needs: bump_version # Wait for the version bump job to finish
steps:
Expand Down
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,15 @@ cd heartbeat-service
### Set Up Virtual Environment

```bash
python3 -m venv venv
python -m venv venv
source venv/bin/activate # On Windows, use venv\Scripts\activate
pip install poetry
poetry install
```

### Install Dependencies
## Configuration

```bash
pip install -r requirements.txt
```

## Configuration (Common for both pub/sub)
This is common for both pub/sub.

```bash
export HEARTBEAT_MODE=publisher # or subscriber
Expand All @@ -109,7 +107,7 @@ export REDIS_PORT=6379
export REDIS_DB=0
```

## Run the application
## Running the application

```bash
python heartbeat.py
Expand Down

0 comments on commit adcd3d8

Please sign in to comment.