Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ body:
If applicable, provide the version number or release tag where this
issue was encountered
options:
- v1.1.1
- v1.2.1
default: 0
validations:
required: false
Expand Down
20 changes: 14 additions & 6 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ jobs:
with:
filters: |
code:
- '!docs/**'
- '!README.md'
- '!CHANGELOG.md'
- '!CONTRIBUTING.md'
- '!CODE_OF_CONDUCT.md'
- '!SECURITY.md'
- '!CONTRIBUTING.md'
- '!LICENSE.md'
- '!MAINTAINERS.md'
- '!README.md'
- '!RELEASE.md'
- '!SECURITY.md'
- '!.gitignore'

- name: Determine result
Expand All @@ -63,15 +63,23 @@ jobs:
- changes
uses: ./.github/workflows/reusable-test-sdk.yaml
with:
image_repo: ghcr.io/agntcy
image_tag: ${{ github.sha }}
dir_chart_version: v1.2.0
dirctl_image_tag: v1.2.0

release:
name: Release
if: ${{ startsWith(github.ref, 'refs/tags/') }}
needs:
- test
uses: ./.github/workflows/reusable-release-sdk.yaml

success:
name: Success
if: ${{ !cancelled() && !contains(needs.*.result, 'cancelled') && !contains(needs.*.result, 'failure') }}
needs:
- changes
- test
- release
runs-on: ubuntu-latest
steps:
- name: Echo Success
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/reusable-release-sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
name: Release SDK

on:
workflow_call:
workflow_dispatch:

permissions:
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/reusable-test-sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ name: Test SDK
on:
workflow_call:
inputs:
image_repo:
dir_chart_version:
required: true
type: string
description: "Image repo to use."
image_tag:
description: "The version of the dir Helm chart to install for the tests."
dirctl_image_tag:
required: true
type: string
description: "Image tag to use."
description: "The tag of the dir-ctl Docker image to use in the tests."

permissions:
id-token: write
Expand Down Expand Up @@ -47,7 +47,7 @@ jobs:

- name: Test Python SDK
env:
CHART_VERSION: "0.0.0-latest"
IMAGE_TAG: latest
DIR_CHART_VERSION: ${{ inputs.dir_chart_version }}
DIRCTL_IMAGE_TAG: ${{ inputs.dirctl_image_tag }}
run: |
task sdk:test:python
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[agntcy/dir]: https://github.com/agntcy/dir
[agntcy/dir-sdk-python]: https://github.com/agntcy/dir-sdk-python

## 1.1.1 (2026-04-02)
## 1.2.1 (2026-04-15)

### Added

Expand Down
35 changes: 35 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Release

This document outlines the process of creating a new release
for the Directory Python SDK.

## 1. Create a release branch

Create a branch for the new release:

1. Update the SDK version in:
- `pyproject.toml`
- `examples/pyproject.toml`
- `.github/ISSUE_TEMPLATE/bug_report.yml`
2. Update the dependencies if necessary:
- [agntcy-dir-grpc-python](https://buf.build/agntcy/dir/sdks/v1.2.0%3Agrpc/python?version=v1.78.0) (Buf SDK)
- [agntcy-dir-protocolbuffers-python](https://buf.build/agntcy/dir/sdks/v1.2.0%3Aprotocolbuffers/python?version=v34.0) (Buf SDK)
- `.github/workflows/ci.yaml` (dir & dir-ctl version)
3. Add an entry to `CHANGELOG.md`

## 2. Create and push tags

After the release branch is merged, update your main branch:

```sh
git checkout main
git pull origin main
```

To trigger the release workflow, create and push the release tag
for the last commit:

```sh
git tag -a v1.2.1
git push origin v1.2.1
```
4 changes: 2 additions & 2 deletions Taskfile.deps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ tasks:
internal: true
run: once
vars:
IMAGE_TAG: "{{ .IMAGE_TAG }}"
DIRCTL_IMAGE_TAG: "{{ .DIRCTL_IMAGE_TAG }}"
preconditions:
- which docker
cmds:
- docker image pull ghcr.io/agntcy/dir-ctl:{{.IMAGE_TAG}}
- docker image pull ghcr.io/agntcy/dir-ctl:{{ .DIRCTL_IMAGE_TAG }}
4 changes: 1 addition & 3 deletions Taskfile.test-env.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@ tasks:
source /tmp/dir-htpasswd-creds.env

{{ .HELM_BIN }} install dir oci://ghcr.io/agntcy/dir/helm-charts/dir \
--version="{{ .CHART_VERSION }}" \
--set apiserver.image.tag="{{ .IMAGE_TAG }}" \
--version="{{ .DIR_CHART_VERSION }}" \
--set apiserver.image.pullSecrets="" \
--set apiserver.service.type="NodePort" \
--set apiserver.service.nodePort="{{.API_NODEPORT}}" \
Expand All @@ -100,7 +99,6 @@ tasks:
{{ if .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_RPS }}--set apiserver.config.ratelimit.per_client_rps="{{ .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_RPS }}"{{ end }} \
{{ if .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_BURST }}--set apiserver.config.ratelimit.per_client_burst="{{ .DIRECTORY_SERVER_RATELIMIT_PER_CLIENT_BURST }}"{{ end }} \
{{ if .DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL }}--set apiserver.config.oasf_api_validation.schema_url="{{ .DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL }}"{{ end }} \
--set apiserver.reconciler.image.tag="{{ .IMAGE_TAG }}" \
--set apiserver.reconciler.config.regsync.interval="10s" \
--set apiserver.reconciler.config.indexer.interval="10s" \
--set apiserver.reconciler.config.name.interval="5s" \
Expand Down
4 changes: 2 additions & 2 deletions Taskfile.vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
version: "3"

vars:
CHART_VERSION: '{{ .CHART_VERSION | default "0.0.0-latest" }}'
IMAGE_TAG: '{{ .IMAGE_TAG | default "latest" }}'
DIR_CHART_VERSION: '{{ .DIR_CHART_VERSION | default "0.0.0-latest" }}'
DIRCTL_IMAGE_TAG: '{{ .DIRCTL_IMAGE_TAG | default "latest" }}'
BIN_DIR: "{{ .ROOT_DIR }}/.bin"
HELM_VERSION: "4.1.3"
HELM_BIN: "{{ .BIN_DIR }}/helm-{{.HELM_VERSION}}"
Expand Down
4 changes: 2 additions & 2 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ tasks:
- defer: { task: sdk:test-env:delete }
- task: sdk:test-env:create
- |
export DIRCTL_IMAGE_TAG="{{ .IMAGE_TAG }}"
export DIRCTL_IMAGE_TAG="{{ .DIRCTL_IMAGE_TAG }}"
export COSIGN_PATH="$(printf "%s" "${COSIGN_PATH:-{{ .COSIGN_BIN }}}")"

# Run SDK tests
'{{.UV_BIN}}' run pytest
'{{ .UV_BIN }}' run pytest

# Run SDK example to verify it works
cd {{ .ROOT_DIR }}/examples
Expand Down
2 changes: 1 addition & 1 deletion examples/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[project]
name = "agntcy-dir"
version = "1.1.1"
version = "1.2.1"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should it be 1.2.0?

@csirmazbendeguz csirmazbendeguz Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the Python package version - 1.2.0 was already released as part of the 1.2.0 release:
https://pypi.org/project/agntcy-dir/

my goal is to release a version 1.2.1 of the SDK after the migration (we will version the SDKs separately from that point onward)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand now 😄 thanks!

description = "Directory SDK"
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
"agntcy-dir-grpc-python==1.78.0.1.20260319131759+f3a65f0dc151",
"agntcy-dir-protocolbuffers-python==34.0.0.1.20260319131759+f3a65f0dc151",
"agntcy-dir-grpc-python==1.78.0.1.20260413212701+cb1fb6353ac1", # v1.2.0
"agntcy-dir-protocolbuffers-python==34.0.0.1.20260413212701+cb1fb6353ac1", # v1.2.0
"authlib>=1.6.9",
"httpx>=0.28.1",
"grpcio>=1.78.0",
Expand Down
14 changes: 7 additions & 7 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading