Skip to content

Commit

Permalink
Merge branch 'develop' into plugin-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shakkernerd authored Dec 23, 2024
2 parents cc2bab6 + 307b9c0 commit 9e87622
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 32 deletions.
34 changes: 5 additions & 29 deletions .github/workflows/integrationTests.yaml
Original file line number Diff line number Diff line change
@@ -1,28 +1,13 @@
name: integration-test
name: Integration Tests
on:
push:
branches:
- "*"
pull_request:
pull_request_target:
branches:
- "*"
jobs:
smoke-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v3
with:
version: 9.4.0

- uses: actions/setup-node@v4
with:
node-version: "23"
cache: "pnpm"

- name: Run smoke tests
run: pnpm run smokeTests
jobs:
integration-tests:
runs-on: ubuntu-latest
env:
Expand All @@ -46,20 +31,11 @@ jobs:
run: pnpm build

- name: Check for API key
id: check_api_key
run: |
if [ -z "$OPENAI_API_KEY" ]; then
echo "::set-output name=api_key_present::false"
else
echo "::set-output name=api_key_present::true"
echo "Error: OPENAI_API_KEY is not set."
exit 1
fi
- name: Run integration tests
if: steps.check_api_key.outputs.api_key_present == 'true'
run: pnpm run integrationTests

- name: Skip integration tests
if: steps.check_api_key.outputs.api_key_present == 'false'
run: |
echo "Skipping integration tests due to missing required API keys"
exit 1
26 changes: 26 additions & 0 deletions .github/workflows/smoke-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: smoke-test
on:
push:
branches:
- "*"
pull_request:
branches:
- "*"

jobs:
smoke-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v3
with:
version: 9.4.0

- uses: actions/setup-node@v4
with:
node-version: "23"
cache: "pnpm"

- name: Run smoke tests
run: pnpm run smokeTests
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ cd eliza-starter
cp .env.example .env
pnpm i && pnpm build && pnpm start
```
Once the agent is running, You should see the message to run "pnpm start:client" at the end.
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
```bash
pnpm start:client
```

Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.

Expand Down
12 changes: 9 additions & 3 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,15 @@ pnpm start --characters="characters/trump.character.json,characters/tate.charact

1. **Node.js Version**

- Ensure Node.js 23.3.0 is installed
- Use `node -v` to check version
- Consider using [nvm](https://github.com/nvm-sh/nvm) to manage Node versions
- Ensure Node.js 23.3.0 is installed
- Use `node -v` to check version
- Consider using [nvm](https://github.com/nvm-sh/nvm) to manage Node versions

NOTE: pnpm may be bundled with a different node version, ignoring nvm. If this is the case, you can use
```bash
pnpm env use --global 23.3.0
```
to force it to use the correct one.

2. **Sharp Installation**
If you see Sharp-related errors:
Expand Down

0 comments on commit 9e87622

Please sign in to comment.