File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 3030 If applicable, provide the version number or release tag where this
3131 issue was encountered
3232 options :
33- - v1.1.0
33+ - v1.2.1
3434 default : 0
3535 validations :
3636 required : false
Original file line number Diff line number Diff line change @@ -37,18 +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'
46- - '!LICENSE.md '
42+ - '!CONTRIBUTING .md'
43+ - '!LICENSE'
4744 - '!MAINTAINERS.md'
48- - '!CONTRIBUTORS.md'
49- - '!AUTHZ.md'
50- - '!API_SPEC.md'
45+ - '!README.md'
5146 - '!RELEASE.md'
47+ - '!SECURITY.md'
5248 - '!.gitignore'
5349
5450 - name : Determine result
6763 - changes
6864 uses : ./.github/workflows/reusable-test-sdk.yaml
6965 with :
70- image_repo : ghcr.io/agntcy
71- 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
7275
7376 success :
7477 name : Success
Original file line number Diff line number Diff line change 44name : Release SDK
55
66on :
7+ workflow_call :
78 workflow_dispatch :
89
910permissions :
Original file line number Diff line number Diff line change @@ -6,14 +6,14 @@ name: Test SDK
66on :
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
1818permissions :
1919 id-token : write
6868
6969 - name : Test JavaScript SDK
7070 env :
71- CHART_VERSION : " 0.0.0-latest "
72- IMAGE_TAG : latest
71+ DIR_CHART_VERSION : ${{ inputs.dir_chart_version }}
72+ DIRCTL_IMAGE_TAG : ${{ inputs.dirctl_image_tag }}
7373 run : |
7474 task sdk:test:javascript
Original file line number Diff line number Diff line change 33[ agntcy/dir ] : https://github.com/agntcy/dir
44[ agntcy/dir-sdk-javascript ] : https://github.com/agntcy/dir-sdk-javascript
55
6- ## 1.1.0 (2026-04-10 )
6+ ## 1.2.1 (2026-04-15 )
77
88### Added
99
Original file line number Diff line number Diff line change 1+ # Release
2+
3+ This document outlines the process of creating a new release
4+ for the Directory JavaScript 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+ - ` package.json `
12+ - ` .github/ISSUE_TEMPLATE/bug_report.yml `
13+ 2 . Update the dependencies if necessary:
14+ - [ @buf /agntcy_dir.bufbuild_es] ( https://buf.build/agntcy/dir/sdks/v1.2.0%3Abufbuild/es?version=v2.9.0 ) (Buf SDK)
15+ - ` .github/workflows/ci.yaml ` (dir & dir-ctl version)
16+ 3 . Add an entry to ` CHANGELOG.md `
17+
18+ ## 2. Create and push tags
19+
20+ After the release branch is merged, update your main branch:
21+
22+ ``` sh
23+ git checkout main
24+ git pull origin main
25+ ```
26+
27+ To trigger the release workflow, create and push the release tag
28+ for the last commit:
29+
30+ ``` sh
31+ git tag -a v1.2.1
32+ git push origin v1.2.1
33+ ```
Original file line number Diff line number Diff line change 7373 internal : true
7474 run : once
7575 vars :
76- IMAGE_TAG : " {{ .IMAGE_TAG }}"
76+ DIRCTL_IMAGE_TAG : " {{ .DIRCTL_IMAGE_TAG }}"
7777 preconditions :
7878 - which docker
7979 cmds :
80- - docker image pull ghcr.io/agntcy/dir-ctl:{{.IMAGE_TAG }}
80+ - docker image pull ghcr.io/agntcy/dir-ctl:{{ .DIRCTL_IMAGE_TAG }}
Original file line number Diff line number Diff line change 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" \
Original file line number Diff line number Diff line change 44version : " 3"
55
66vars :
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}}"
Original file line number Diff line number Diff line change 8181 - task : sdk:test-env:create
8282 - defer : { task: sdk:test-env:delete }
8383 - |
84+ export DIRCTL_IMAGE_TAG="{{ .DIRCTL_IMAGE_TAG }}"
8485 export COSIGN_PATH="$(printf "%s" "${COSIGN_PATH:-{{ .COSIGN_BIN }}}")"
85- export DIRCTL_IMAGE_TAG="{{ .IMAGE_TAG }}"
8686
8787 # Run SDK tests
8888 npm run test
You can’t perform that action at this time.
0 commit comments