Skip to content

Commit e7e4e57

Browse files
chore: minor repo setup changes (#7)
* chore: add repo metadata.json * chore: label workflow, lint dev deps added, DEVELOPER.md update
1 parent a912368 commit e7e4e57

File tree

6 files changed

+274
-5
lines changed

6 files changed

+274
-5
lines changed

.github/labels.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
- name: duplicate
16+
color: ededed
17+
description: ""
18+
19+
- name: 'type: bug'
20+
color: db4437
21+
description: Error or flaw in code with unintended results or allowing sub-optimal
22+
usage patterns.
23+
- name: 'type: cleanup'
24+
color: c5def5
25+
description: An internal cleanup or hygiene concern.
26+
- name: 'type: docs'
27+
color: 0000A0
28+
description: Improvement to the documentation for an API.
29+
- name: 'type: feature request'
30+
color: c5def5
31+
description: ‘Nice-to-have’ improvement, new feature or different behavior or design.
32+
- name: 'type: process'
33+
color: c5def5
34+
description: A process-related concern. May include testing, release, or the like.
35+
- name: 'type: question'
36+
color: c5def5
37+
description: Request for information or clarification.
38+
39+
- name: 'priority: p0'
40+
color: b60205
41+
description: Highest priority. Critical issue. P0 implies highest priority.
42+
- name: 'priority: p1'
43+
color: ffa03e
44+
description: Important issue which blocks shipping the next release. Will be fixed
45+
prior to next release.
46+
- name: 'priority: p2'
47+
color: fef2c0
48+
description: Moderately-important priority. Fix may not be included in next release.
49+
- name: 'priority: p3'
50+
color: ffffc7
51+
description: Desirable enhancement or fix. May not be included in next release.
52+
53+
- name: do not merge
54+
color: d93f0b
55+
description: Indicates a pull request not ready for merge, due to either quality
56+
or timing.
57+
58+
- name: 'autorelease: pending'
59+
color: ededed
60+
description: Release please needs to do its work on this.
61+
- name: 'autorelease: triggered'
62+
color: ededed
63+
description: Release please has triggered a release for this.
64+
- name: 'autorelease: tagged'
65+
color: ededed
66+
description: Release please has completed a release for this.
67+
68+
- name: 'tests: run'
69+
color: 3DED97
70+
description: Label to trigger Github Action tests.

.github/workflows/sync-labels.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: Sync Labels
16+
on:
17+
push:
18+
branches:
19+
- main
20+
21+
# Declare default permissions as read only.
22+
permissions: read-all
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-latest
27+
permissions:
28+
contents: 'read'
29+
issues: 'write'
30+
pull-requests: 'write'
31+
steps:
32+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
33+
- uses: micnncim/action-label-syncer@3abd5ab72fda571e69fffd97bd4e0033dd5f495c # v1.3.0
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
with:
37+
manifest: .github/labels.yaml

.repo-metadata.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"name": "llama-index-spanner",
3+
"name_pretty": "Spanner for LlamaIndex - Python",
4+
"issue_tracker": "https://github.com/googleapis/llama-index-spanner-python/issues",
5+
"client_documentation": "https://github.com/googleapis/llama-index-spanner-python/tree/main/docs",
6+
"release_level": "preview",
7+
"language": "python",
8+
"library_type": "OTHER",
9+
"repo": "googleapis/llama-index-spanner-python",
10+
"distribution_name": "llama-index-spanner",
11+
"requires_billing": true,
12+
"codeowner_team": "@googleapis/senseai-eco"
13+
}

DEVELOPER.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,20 @@ and creating release PRs.
1414

1515
Learn more by reading [How should I write my commits?](https://github.com/googleapis/release-please?tab=readme-ov-file#how-should-i-write-my-commits)
1616

17-
<!-- ## Testing
17+
## Testing
1818

1919
### Run tests locally
2020

21-
1. Set environment variables for `SPANNER_INSTANCE_ID`, `SPANNER_DATABASE_ID`, `SPANNER_GRAPH_NAME`
21+
1. Set environment variables for `SPANNER_INSTANCE_ID`, `SPANNER_DATABASE_ID`, `SPANNER_GRAPH_NAME`, `GEMINI_API_KEY` or `GOOGLE_API_KEY`
2222

23-
1. Run pytest to automatically run all tests:
23+
2. Run pytest to automatically run all tests:
2424

2525
```bash
2626
pytest
2727
```
2828

29+
Note: Use the `-n 7` flag to set 7 workers for parallel testing. Ensure the database has no existing graphs, as there is a limit on the number of graphs allowed.
30+
2931
### CI Platform Setup
3032

3133
Cloud Build is used to run tests against Google Cloud resources in test project: langchain-spanner-testing.
@@ -90,4 +92,4 @@ Here is a breakdown of the report:
9092
- `Missing`: lines that are not covered by tests.
9193

9294

93-
[triggers]: https://console.cloud.google.com/cloud-build/triggers?e=13802955&project=langchain-spanner-testing -->
95+
[triggers]: https://console.cloud.google.com/cloud-build/triggers?e=13802955&project=langchain-spanner-testing

poetry.lock

Lines changed: 145 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ llama-index-readers-wikipedia = "^0.3.0"
2121
wikipedia = "^1.4.0"
2222
llama-index-embeddings-google-genai = "^0.1.0"
2323
ipykernel = "^6.29.5"
24+
black = {extras = ["jupyter"], version = "^25.1.0"}
25+
isort = "^6.0.1"
26+
mypy = "^1.16.0"
2427

2528
[build-system]
2629
requires = ["poetry-core"]

0 commit comments

Comments
 (0)