Skip to content

Commit b3eb610

Browse files
chore(dir-sdk-python): pin version to 1.2.0
Signed-off-by: Bendegúz Csirmaz <csirmazbendeguz@gmail.com>
1 parent d7fc79b commit b3eb610

13 files changed

Lines changed: 76 additions & 34 deletions

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ body:
3030
If applicable, provide the version number or release tag where this
3131
issue was encountered
3232
options:
33-
- v1.1.1
33+
- v1.2.1
3434
default: 0
3535
validations:
3636
required: false

.github/workflows/ci.yaml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ jobs:
3737
with:
3838
filters: |
3939
code:
40-
- '!docs/**'
41-
- '!README.md'
4240
- '!CHANGELOG.md'
43-
- '!CONTRIBUTING.md'
4441
- '!CODE_OF_CONDUCT.md'
45-
- '!SECURITY.md'
42+
- '!CONTRIBUTING.md'
4643
- '!LICENSE.md'
4744
- '!MAINTAINERS.md'
45+
- '!README.md'
46+
- '!RELEASE.md'
47+
- '!SECURITY.md'
4848
- '!.gitignore'
4949
5050
- name: Determine result
@@ -63,15 +63,23 @@ jobs:
6363
- changes
6464
uses: ./.github/workflows/reusable-test-sdk.yaml
6565
with:
66-
image_repo: ghcr.io/agntcy
67-
image_tag: ${{ github.sha }}
66+
dir_chart_version: v1.2.0
67+
dirctl_image_tag: v1.2.0
68+
69+
release:
70+
name: Release
71+
if: ${{ startsWith(github.ref, 'refs/tags/') }}
72+
needs:
73+
- test
74+
uses: ./.github/workflows/reusable-release-sdk.yaml
6875

6976
success:
7077
name: Success
7178
if: ${{ !cancelled() && !contains(needs.*.result, 'cancelled') && !contains(needs.*.result, 'failure') }}
7279
needs:
7380
- changes
7481
- test
82+
- release
7583
runs-on: ubuntu-latest
7684
steps:
7785
- name: Echo Success

.github/workflows/reusable-release-sdk.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
name: Release SDK
55

66
on:
7+
workflow_call:
78
workflow_dispatch:
89

910
permissions:

.github/workflows/reusable-test-sdk.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ name: Test SDK
66
on:
77
workflow_call:
88
inputs:
9-
image_repo:
9+
dir_chart_version:
1010
required: true
1111
type: string
12-
description: "Image repo to use."
13-
image_tag:
12+
description: "The version of the dir Helm chart to install for the tests."
13+
dirctl_image_tag:
1414
required: true
1515
type: string
16-
description: "Image tag to use."
16+
description: "The tag of the dir-ctl Docker image to use in the tests."
1717

1818
permissions:
1919
id-token: write
@@ -47,7 +47,7 @@ jobs:
4747
4848
- name: Test Python SDK
4949
env:
50-
CHART_VERSION: "0.0.0-latest"
51-
IMAGE_TAG: latest
50+
DIR_CHART_VERSION: ${{ inputs.dir_chart_version }}
51+
DIRCTL_IMAGE_TAG: ${{ inputs.dirctl_image_tag }}
5252
run: |
5353
task sdk:test:python

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[agntcy/dir]: https://github.com/agntcy/dir
44
[agntcy/dir-sdk-python]: https://github.com/agntcy/dir-sdk-python
55

6-
## 1.1.1 (2026-04-02)
6+
## 1.2.1 (2026-04-15)
77

88
### Added
99

RELEASE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Release
2+
3+
This document outlines the process of creating a new release
4+
for the Directory Python SDK.
5+
6+
## 1. Create a release branch
7+
8+
Create a branch for the new release:
9+
10+
1. Update the SDK version in:
11+
- `pyproject.toml`
12+
- `examples/pyproject.toml`
13+
- `.github/ISSUE_TEMPLATE/bug_report.yml`
14+
2. Update the dependencies if necessary:
15+
- [agntcy-dir-grpc-python](https://buf.build/agntcy/dir/sdks/v1.2.0%3Agrpc/python?version=v1.78.0) (Buf SDK)
16+
- [agntcy-dir-protocolbuffers-python](https://buf.build/agntcy/dir/sdks/v1.2.0%3Aprotocolbuffers/python?version=v34.0) (Buf SDK)
17+
- `.github/workflows/ci.yaml` (dir & dir-ctl version)
18+
3. Add an entry to `CHANGELOG.md`
19+
20+
## 2. Create and push tags
21+
22+
After the release branch is merged, update your main branch:
23+
24+
```sh
25+
git checkout main
26+
git pull origin main
27+
```
28+
29+
To trigger the release workflow, create and push the release tag
30+
for the last commit:
31+
32+
```sh
33+
git tag -a v1.2.1
34+
git push origin v1.2.1
35+
```

Taskfile.deps.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ tasks:
8888
internal: true
8989
run: once
9090
vars:
91-
IMAGE_TAG: "{{ .IMAGE_TAG }}"
91+
DIRCTL_IMAGE_TAG: "{{ .DIRCTL_IMAGE_TAG }}"
9292
preconditions:
9393
- which docker
9494
cmds:
95-
- docker image pull ghcr.io/agntcy/dir-ctl:{{.IMAGE_TAG}}
95+
- docker image pull ghcr.io/agntcy/dir-ctl:{{ .DIRCTL_IMAGE_TAG }}

Taskfile.test-env.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@ tasks:
7979
source /tmp/dir-htpasswd-creds.env
8080
8181
{{ .HELM_BIN }} install dir oci://ghcr.io/agntcy/dir/helm-charts/dir \
82-
--version="{{ .CHART_VERSION }}" \
83-
--set apiserver.image.tag="{{ .IMAGE_TAG }}" \
82+
--version="{{ .DIR_CHART_VERSION }}" \
8483
--set apiserver.image.pullSecrets="" \
8584
--set apiserver.service.type="NodePort" \
8685
--set apiserver.service.nodePort="{{.API_NODEPORT}}" \
@@ -100,7 +99,6 @@ tasks:
10099
{{ if .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_RPS }}--set apiserver.config.ratelimit.per_client_rps="{{ .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_RPS }}"{{ end }} \
101100
{{ if .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_BURST }}--set apiserver.config.ratelimit.per_client_burst="{{ .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_BURST }}"{{ end }} \
102101
{{ if .DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL }}--set apiserver.config.oasf_api_validation.schema_url="{{ .DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL }}"{{ end }} \
103-
--set apiserver.reconciler.image.tag="{{ .IMAGE_TAG }}" \
104102
--set apiserver.reconciler.config.regsync.interval="10s" \
105103
--set apiserver.reconciler.config.indexer.interval="10s" \
106104
--set apiserver.reconciler.config.name.interval="5s" \

Taskfile.vars.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
version: "3"
55

66
vars:
7-
CHART_VERSION: '{{ .CHART_VERSION | default "0.0.0-latest" }}'
8-
IMAGE_TAG: '{{ .IMAGE_TAG | default "latest" }}'
7+
DIR_CHART_VERSION: '{{ .DIR_CHART_VERSION | default "0.0.0-latest" }}'
8+
DIRCTL_IMAGE_TAG: '{{ .DIRCTL_IMAGE_TAG | default "latest" }}'
99
BIN_DIR: "{{ .ROOT_DIR }}/.bin"
1010
HELM_VERSION: "4.1.3"
1111
HELM_BIN: "{{ .BIN_DIR }}/helm-{{.HELM_VERSION}}"

Taskfile.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ tasks:
6565
- defer: { task: sdk:test-env:delete }
6666
- task: sdk:test-env:create
6767
- |
68-
export DIRCTL_IMAGE_TAG="{{ .IMAGE_TAG }}"
68+
export DIRCTL_IMAGE_TAG="{{ .DIRCTL_IMAGE_TAG }}"
6969
export COSIGN_PATH="$(printf "%s" "${COSIGN_PATH:-{{ .COSIGN_BIN }}}")"
7070
7171
# Run SDK tests
72-
'{{.UV_BIN}}' run pytest
72+
'{{ .UV_BIN }}' run pytest
7373
7474
# Run SDK example to verify it works
7575
cd {{ .ROOT_DIR }}/examples

0 commit comments

Comments
 (0)