Skip to content

Commit

Permalink
Run cog -r in PRs, use that to update logging.md with new tables (#616)
Browse files Browse the repository at this point in the history
* Create cog.yml
* Document attachments and prompt_attachments table schemas

Closes #615

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
simonw and github-actions[bot] authored Nov 6, 2024
1 parent 98d2c19 commit febbc04
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 2 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/cog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Run Cog

on:
pull_request:
types: [opened, synchronize]

permissions:
contents: write
pull-requests: write

jobs:
run-cog:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}

- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
run: pip install -e '.[test]'

- name: Run cog
run: |
cog -r -p "import sys, os; sys._called_from_test=True; os.environ['LLM_USER_PATH'] = '/tmp'" docs/**/*.md docs/*.md
- name: Check for changes
id: check-changes
run: |
if [ -n "$(git diff)" ]; then
echo "changes=true" >> $GITHUB_OUTPUT
else
echo "changes=false" >> $GITHUB_OUTPUT
fi
- name: Commit and push if changed
if: steps.check-changes.outputs.changes == 'true'
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add -A
git commit -m "Ran cog"
git push
18 changes: 16 additions & 2 deletions docs/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def cleanup_sql(sql):
return first_line + '(\n ' + ',\n '.join(columns) + '\n);'
cog.out("```sql\n")
for table in ("conversations", "responses", "responses_fts"):
for table in ("conversations", "responses", "responses_fts", "attachments", "prompt_attachments"):
schema = db[table].schema
cog.out(format(cleanup_sql(schema)))
cog.out("\n")
Expand Down Expand Up @@ -166,6 +166,20 @@ CREATE VIRTUAL TABLE [responses_fts] USING FTS5 (
[response],
content=[responses]
);
CREATE TABLE [attachments] (
[id] TEXT PRIMARY KEY,
[type] TEXT,
[path] TEXT,
[url] TEXT,
[content] BLOB
);
CREATE TABLE [prompt_attachments] (
[response_id] TEXT REFERENCES [responses]([id]),
[attachment_id] TEXT REFERENCES [attachments]([id]),
[order] INTEGER,
PRIMARY KEY ([response_id],
[attachment_id])
);
```
<!-- [[[end]]] -->
`responses_fts` configures [SQLite full-text search](https://www.sqlite.org/fts5.html) against the `prompt` and `response` columns in the `responses` table.
`responses_fts` configures [SQLite full-text search](https://www.sqlite.org/fts5.html) against the `prompt` and `response` columns in the `responses` table.

0 comments on commit febbc04

Please sign in to comment.