Skip to content

Commit f551522

Browse files
authored
Merge branch 'master' into copilot/fix-983-2
2 parents b1264ae + 50fc030 commit f551522

2 files changed

Lines changed: 50 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,14 @@ app_package.schema.add_fields(
108108

109109
## Documentation source
110110

111-
Very often you need to consult the Vespa documentation. For example for format of the XML configuration files, or for documentation of a specific query parameter, and so on. Find relevant info using the context7 MCP server that you have available. (repo: vespa-engine/documentation)
111+
Very often you need to consult the Vespa documentation. For example for format of the XML configuration files, or for documentation of a specific query parameter, and so on. Find relevant info using the context7 MCP server that you have available. (repo: vespa-engine/documentation).
112112

113+
You can also use context7 MCP server to search documentation of other libraries used in the project, such as `httpx`, `requests`, `docker`, etc.
113114

114115
## Development Workflow
115116

116117
We use `uv` for managing dependencies.
117-
To install the project with development dependencies, run:
118+
You already have the project set up with development dependencies, run:
118119
```bash
119120
uv sync --extra dev
120121
```
@@ -123,4 +124,11 @@ After that you can run tests with:
123124
```bash
124125
uv run pytest tests/unit/ -v
125126
```
126-
You can also replace `unit`with `integration` to run integration tests, or just `tests/` to run all tests, or run specific test files or test cases the same way.
127+
You can also replace `unit` with `integration` to run integration tests, or just `tests/` to run all tests, or run specific test files or test cases the same way.
128+
129+
Doctests:
130+
You can run doctests in the examples and documentation with:
131+
```bash
132+
uv sync --extra dev --extra docs
133+
uv run pytest tests/mktestdocs -s -v
134+
```
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "Copilot Setup Steps"
2+
3+
# Automatically run the setup steps when they are changed to allow for easy validation, and
4+
# allow manual testing through the repository's "Actions" tab
5+
on:
6+
workflow_dispatch:
7+
push:
8+
paths:
9+
- .github/workflows/copilot-setup-steps.yml
10+
pull_request:
11+
paths:
12+
- .github/workflows/copilot-setup-steps.yml
13+
14+
jobs:
15+
# The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
16+
copilot-setup-steps:
17+
runs-on: ubuntu-latest
18+
19+
# Set the permissions to the lowest permissions possible needed for your steps.
20+
# Copilot will be given its own token for its operations.
21+
permissions:
22+
# If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
23+
contents: read
24+
25+
# You can define any steps you want, and they will run before the agent starts.
26+
# If you do not check out your code, Copilot will do this for you.
27+
steps:
28+
- name: Install pandoc
29+
run: |
30+
sudo apt-get install -y pandoc
31+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
32+
- name: Install uv
33+
uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6
34+
with:
35+
python-version: "3.10"
36+
37+
- name: Install dependencies
38+
run: |
39+
uv sync --extra dev

0 commit comments

Comments
 (0)