Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
193 commits
Select commit Hold shift + click to select a range
9c58217
use gonfalon generated openapi 3 spec
kbrackbill Feb 24, 2021
02c9599
clean up circle config
kbrackbill Feb 24, 2021
f1d3cb8
get openapi spec from prod gonfalon
kbrackbill Mar 8, 2021
1205ac5
use staging url
Mar 26, 2021
a20dde5
update go sample to use updated go client
Mar 26, 2021
0d993db
revert back to production openapi spec
Mar 29, 2021
7dc15ad
fix Python sample
Mar 30, 2021
7913079
fix swagger-client import name
Mar 30, 2021
0aff03e
update typescript target to axios
Mar 30, 2021
5d05428
update java sample code to use new java client
Mar 31, 2021
594f5ef
update javascript sample code to use new javascript client
Mar 31, 2021
cae275c
update ruby sample code to use new ruby client
Apr 1, 2021
f2c0f90
update ruby client for testing
Apr 1, 2021
e3be908
update java sample
Apr 4, 2021
b63d4d5
[ch103716] Correct typo in big segment update operation name
rengawm Apr 8, 2021
3976a91
Merge pull request #189 from launchdarkly/mattwagner/ch103716/fix-typo
rengawm Apr 8, 2021
6c2261b
[ch105622] add flag dependencies endpoints to openapi (#190)
hjacobs1 Apr 21, 2021
9d6f732
merge from public after release
LaunchDarklyCI Apr 21, 2021
bde782f
resolve merge
Jun 4, 2021
b3d3268
Merge branch 'kbrack/ch98924/gonfalon-openapi' into goas
Jun 4, 2021
9873a40
Bw/ch109131/generator migration start (#192)
Jun 7, 2021
72f4a7e
update releaser (#193)
Jun 7, 2021
edcb80b
Updating sample codes to work with latest spec (#194)
bwoskow-ld Jul 2, 2021
267a814
update readme links (#195)
bwoskow-ld Jul 2, 2021
4a5b1c3
Adding the DX squad as codeowners
bwoskow-ld Jul 9, 2021
73d0938
Update docs for environment approval settings (#196)
vatasha Jul 9, 2021
f0f54c9
add sample code link (#198)
bwoskow-ld Jul 14, 2021
1e0b8e3
temporarily remove csharp from publication process (#197)
bwoskow-ld Jul 14, 2021
f24ae04
Remove vestigial files
XieX Jul 14, 2021
2014579
Update readme
XieX Jul 14, 2021
ccc5f67
Rev to open api generator 5.2
XieX Jul 14, 2021
669c8da
Skip spec validation to avoid breaking it
XieX Jul 14, 2021
d83e675
Update README.md
XieX Jul 14, 2021
274aa7c
Update readme
XieX Jul 15, 2021
21e2da1
Clean description refs from openapi spec before generating
XieX Jul 15, 2021
3248e40
Revert "Clean description refs from openapi spec before generating"
XieX Jul 15, 2021
0b0188c
Skip spec validation
XieX Jul 15, 2021
1cd46d9
86 github pages
XieX Jul 16, 2021
7a7f964
Revert removal of java sdk gh page
XieX Jul 16, 2021
6092bee
Remove validation skipping
XieX Jul 20, 2021
0f1c1bb
Samples sans reps2
XieX Jul 28, 2021
5fdb366
s/GlobalFlagRep/FlagPost
XieX Jul 28, 2021
fba0f72
s/VariateRep/FlagPostVariations
XieX Jul 28, 2021
ef3446f
pass in git info to every clinet (#200)
Jul 29, 2021
7689bb4
update docs for approvals copy flag (#201)
Aug 2, 2021
c9c01f4
merge from public after release
Aug 6, 2021
e322e77
Update go example
XieX Aug 6, 2021
87d9353
Use patched version of openapi-generator-cli temporarily
XieX Aug 18, 2021
cef847c
Update ld-openapi-generator-cli.jar
XieX Aug 18, 2021
7bb8d5f
Merge pull request #199 from launchdarkly/christie/ch114006/clean-up-…
XieX Aug 18, 2021
411a164
Merge branch 'master' into goas
XieX Aug 18, 2021
dad9216
further implementation of Dockerized Releaser (#204)
eli-darkly Aug 26, 2021
b098579
Merge branch 'master' into goas
XieX Aug 26, 2021
7261fc1
Update examples
XieX Aug 26, 2021
4b32c1e
Fix python sample
XieX Aug 26, 2021
4983e57
Fix ruby sample
XieX Aug 26, 2021
6a2222e
verify that client code builds, fix (most) Java build issues, make dr…
eli-darkly Aug 27, 2021
9adf26f
update goas branch for new release process (#206)
eli-darkly Aug 30, 2021
78fb16c
fix problems with Java and JavaScript client builds (#207)
eli-darkly Aug 30, 2021
0c5c3b4
Fix typescript sample code (#208)
Aug 31, 2021
f5bc3c3
Merge branch 'master' into goas
XieX Aug 31, 2021
0c02abc
Merge pull request #203 from launchdarkly/goas
XieX Sep 1, 2021
4490306
Fix bad merge
XieX Sep 1, 2021
df0e1bb
Merge pull request #209 from launchdarkly/christie/fix-bad-merge
XieX Sep 1, 2021
f99020d
merge from public after release
Sep 1, 2021
e70aa89
adding github host key (#210)
Sep 1, 2021
1958762
Merge branch 'master' of github.com:launchdarkly/ld-openapi
bwoskow-ld Sep 1, 2021
0f166ec
add ssh dir
Sep 1, 2021
08002ae
Merge pull request #211 from launchdarkly/dob/ssh
XieX Sep 1, 2021
02f0c09
Merge branch 'master' of github.com:launchdarkly/ld-openapi
bwoskow-ld Sep 1, 2021
848210e
back out previous ssh changes and correctly use https (#212)
Sep 2, 2021
9be13e8
Merge branch 'master' of github.com:launchdarkly/ld-openapi
bwoskow-ld Sep 2, 2021
cef27e5
Java Client Changes (#213)
Sep 8, 2021
aec6e98
Replace deprecated docker image usage with newer CircleCI docker imag…
bwoskow-ld Sep 22, 2021
694e6d0
api-client-javascript 6.0.0 doesn't work due to incorrect package gen…
carmenquan Sep 28, 2021
74f88df
fix python build (#216)
Sep 28, 2021
23e16c4
[sc124605] Removing custom template for ruby client (#217)
carmenquan Sep 29, 2021
c5d62a3
merge from public after release
Sep 29, 2021
591b28f
using token username (#218)
carmenquan Sep 29, 2021
7c4696d
allow release to proceed if a per-target publish step failed only bec…
eli-darkly Sep 30, 2021
13922c0
Merge pull request #219 from launchdarkly/eb/ch124841/skip-duplicate-…
eli-darkly Oct 1, 2021
e7444a1
merge from public after release
Oct 1, 2021
9415d88
update Makefile (#220)
Dec 1, 2021
f485f71
renaming variate to variation (#222)
carmenquan Dec 2, 2021
6d9b668
update generator (#221)
carmenquan Dec 3, 2021
6a3c938
merge from public after release
Dec 3, 2021
c24f99e
update .jar (#223)
carmenquan Dec 3, 2021
d5614ba
merge from public after release
Dec 3, 2021
20099f5
update version template (#224)
Dec 6, 2021
b446ce2
switch to gradlew, update from deprecated ghpages library (#225)
carmenquan Jan 5, 2022
c508a8d
allow execution of gradle wrapper (#226)
carmenquan Jan 6, 2022
cb953db
merge from public after release
Jan 6, 2022
bef9393
merge from public after release
Jan 15, 2022
5370371
Remove publish to java gh pages (#228)
carmenquan Mar 3, 2022
5c129ce
remove csharp dotnet references (#230)
carmenquan Mar 3, 2022
2af1865
Update branch from master to main (#229)
carmenquan Mar 11, 2022
37ed5ef
merge from public after release
Mar 11, 2022
428e83e
merge from public after release
Apr 12, 2022
af193d1
merge from public after release
Apr 29, 2022
90b118b
update codeowners (#235)
jazanne Jun 8, 2022
7e84493
[sc-156083] Add php sample app (#234)
jazanne Jun 9, 2022
3a58257
Update to OpenAPI Generator 6.0.0 (#233)
carmenquan Jul 11, 2022
68f2e81
merge from public after release
Jul 11, 2022
75469cc
Adding template for fixing restructuredtext issue (#238)
carmenquan Jul 11, 2022
d52442e
merge from public after release
Jul 11, 2022
b2ac130
adding .gitignore file (#239)
carmenquan Jul 11, 2022
deba82d
merge from public after release
Jul 11, 2022
3ed1f73
Rename gitignore mustache file (#240)
carmenquan Jul 12, 2022
c430adf
only updating java (#241)
carmenquan Jul 12, 2022
8798ef0
merge from public after release
Jul 12, 2022
a28bf48
add wildcards (#242)
carmenquan Jul 12, 2022
2a688ff
merge from public after release
Jul 12, 2022
d614eca
merge from public after release
Jul 12, 2022
1b9a282
fix: [sc-160524] Need to remove all old files before copying new targ…
carmenquan Jul 20, 2022
5bcce16
adding back other clients (#243)
carmenquan Aug 11, 2022
5e71bf1
Update codeowners (#245)
carmenquan Aug 23, 2022
537c9c0
merge from public after release
Nov 21, 2022
3fdd0fb
Update SSM parameter paths (#247)
lucywyman Feb 28, 2023
a73a23a
merge from public after release
Feb 28, 2023
fa0f8b8
Only include 'View code' link if sample code is available (#248)
lucywyman Apr 10, 2023
ec516af
Update Axios dependency in Typescript client (#251)
ldhenry May 15, 2024
9a23b8a
Generate go interface (#252)
ldhenry May 15, 2024
e7cc9a6
merge from public after release
May 16, 2024
3b7867c
Fix typo in package.json template extension (#253)
ldhenry May 16, 2024
3b039a2
merge from public after release
May 16, 2024
fc9eae4
Transfer code ownership (#254)
ldhenry Aug 16, 2024
4511d08
merge from public after release
Oct 14, 2024
c90a0da
[RO-771] Migrate repo from Releaser to manual GH Action (#255)
lucywyman Dec 12, 2024
e568639
Try pinning checkout version to work with Docker images (#256)
lucywyman Dec 12, 2024
8252b34
Try default ubuntu image and hope it magically has everything we need…
lucywyman Dec 12, 2024
46dfb4d
[RO-771] Add manual setup steps (#258)
lucywyman Dec 13, 2024
fcd541d
Sudo install golang (#259)
lucywyman Dec 13, 2024
69623c0
Sudo python update for file permissions (#260)
lucywyman Dec 13, 2024
e96e03c
Give GH action permission (#261)
lucywyman Dec 13, 2024
2aaf689
Use java 11 instead of 17 (#262)
lucywyman Dec 13, 2024
9ad100c
Remove java env attempt (#263)
lucywyman Dec 13, 2024
8ba48f4
Log the stack size for Java. (#264)
paddycarver Dec 13, 2024
d8ad9d9
Bump java thread stack size (#265)
lucywyman Dec 13, 2024
1a98ece
Try setting stack size in gradle.properties (#266)
lucywyman Dec 13, 2024
b287e43
Run prepare script to set up secrets for publishing (#267)
lucywyman Dec 13, 2024
f30ab00
Add publishing secrets as env vars to get written to files (#268)
lucywyman Dec 13, 2024
341fb72
Correct path for java code signing keyring (#269)
lucywyman Dec 13, 2024
c93abab
Download gpg key to correct path (#270)
lucywyman Dec 13, 2024
40c5eb4
Typo in Makefile (#271)
lucywyman Dec 13, 2024
cc3ded5
[DOCS-1155] Update README-PREFIX to not hardcode latest version (#272)
lucywyman Jan 29, 2025
c55c959
Update CODEOWNERS file (#273)
ldhenry Feb 25, 2025
b70ba04
update packaging to be compatible with latest twine
blaqbern Apr 4, 2025
6fe39ca
Merge pull request #274 from launchdarkly/cblackburn/fix-pypi-upload-…
blaqbern Apr 4, 2025
030b16a
testing gha migration
aacharya-ld Oct 7, 2025
62e57c7
user id fix
aacharya-ld Oct 7, 2025
429aa37
testing gha
aacharya-ld Oct 7, 2025
48580d2
fixing version
aacharya-ld Oct 7, 2025
cd75526
adding rusnon
aacharya-ld Oct 7, 2025
a8a2e46
removed id
aacharya-ld Oct 7, 2025
a7fbecd
updating runson
aacharya-ld Oct 7, 2025
bf76249
added user
aacharya-ld Oct 7, 2025
db240d4
fixing uid
aacharya-ld Oct 7, 2025
57633b5
removed sudo
aacharya-ld Oct 7, 2025
d3939bf
removed cache in build step
aacharya-ld Oct 7, 2025
1547f03
back to gha
aacharya-ld Oct 7, 2025
4cdc1e9
adding php as well
aacharya-ld Oct 8, 2025
33cd388
added api key
aacharya-ld Oct 8, 2025
9d613f7
fixing uid
aacharya-ld Oct 8, 2025
f33e7c1
fixing ruby
aacharya-ld Oct 8, 2025
4a44e85
fixing go
aacharya-ld Oct 8, 2025
ad6767a
fixing javascript
aacharya-ld Oct 8, 2025
9117891
fixing flag npx
aacharya-ld Oct 8, 2025
9b1f503
js fix
aacharya-ld Oct 8, 2025
4db0165
fixing js version
aacharya-ld Oct 8, 2025
fb1c75d
testing java fix
aacharya-ld Oct 8, 2025
8d5a479
revert java code as its working fine
aacharya-ld Oct 8, 2025
7286ff6
Merge pull request #277 from launchdarkly/aacharya/migration-gha
aacharya-ld Oct 8, 2025
e9f4b27
Bump generator to v 7.5.0 (#250)
ldhenry Oct 9, 2025
00a02e1
[EXPT-3347] Attempt to Fix Java Compilation Errors (#276)
bvivio Oct 9, 2025
ddcca6a
[REL-10048] Update generator to v7.16.0 (#279)
ldhenry Oct 9, 2025
99219f9
[REL-10048] Fix Java build (#280)
ldhenry Oct 10, 2025
c2c2bad
[REL-10138] Migrate Maven publish from OSSRH to Sonatype Central (#281)
ldhenry Oct 15, 2025
cc162da
[REL-10138] Fix nexusStaging serverUrl for Sonatype Central (#282)
ldhenry Oct 15, 2025
87063ce
(bug-fix) Update form-data dependency (#275)
lucywyman Oct 15, 2025
155120d
remove developer relations from CODEOWNERS (#284)
Oct 16, 2025
de4f883
[REL-10138] Migrate from nexus-staging plugin to gradle-nexus-publish…
ldhenry Oct 16, 2025
1d57744
[REL-10138] Fix Gradle task name to closeAndReleaseSonatypeStagingRep…
ldhenry Oct 17, 2025
53f454d
[REL-10233] add dependency-scan GHA to OpenAPI generation (#286)
sloloris Oct 21, 2025
2135ae0
[REL-10444] add additionalProperty to set axios version to latest (#287)
cspath1 Oct 29, 2025
d152728
Squashed commit of the following:
cspath1 Oct 29, 2025
3975422
Merge branch 'main' of github.com:launchdarkly/ld-openapi
cspath1 Oct 30, 2025
6284ec2
Fix whitespace in GH workflow files (#289)
drewinglis Dec 3, 2025
3781843
Update CODEOWNERS
tknopp-ld Jan 7, 2026
e27ba4f
Merge pull request #292 from launchdarkly/tknopp/chore/update-codeowners
tknopp-ld Jan 7, 2026
52ac355
[REL-11491] Setting the default API version to v4 + fixing several CI…
bwoskow-ld Jan 7, 2026
7eab99a
[REL-11491] Extracting out the api version value to a variable (#293)
bwoskow-ld Jan 7, 2026
a01aa45
[REL-11803] removing the php and javascript targets (#294)
bwoskow-ld Jan 24, 2026
2fe55ce
Merge branch 'main' of github.com:launchdarkly/ld-openapi-private
cspath1 Feb 3, 2026
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/runs-on.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
_extends: .github-private
_extends: .github-private
53 changes: 4 additions & 49 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: CI (build + client samples)
- main

env:
LD_API_KEY: ${{ secrets.LD_API_KEY }}
LD_API_KEY: ${{ secrets.LD_API_KEY }}

permissions:
contents: read
Expand Down Expand Up @@ -82,33 +82,9 @@ jobs:
- name: Run Go sample
env:
GO111MODULE: 'on'
run: make
test-javascript:
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v4
- name: Download targets
uses: actions/download-artifact@v4
with:
name: targets
path: targets
- uses: actions/setup-node@v4
with:
node-version: '20'
- name: Build JS client
working-directory: targets/api-client-javascript
run: |
rm -rf node_modules dist
npm install
npx --yes babel src -d dist --plugins @babel/plugin-transform-modules-commonjs
# TODO: Fix this test
# - name: Run JS sample
# run: |
# cd samples/javascript
# # Install the local package directly
# npm install
# node index.js
cd samples/go
make
test-python:
runs-on: ubuntu-latest
needs: build
Expand Down Expand Up @@ -210,37 +186,16 @@ jobs:
npm install
npm run build
npm start
test-php:
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v4
- name: Download targets
uses: actions/download-artifact@v4
with:
name: targets
path: targets
- uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
- name: Run PHP sample
working-directory: samples/php
run: |
echo '{"require":{"launchdarkly/api-client-php":"@dev","guzzlehttp/guzzle":"*"},"repositories":[{"type":"path","url":"../../targets/api-client-php","options":{"symlink":true}}]}' > composer.json
composer update
php index.php

check-success:
name: Check Success
needs:
- build
- test-go
- test-javascript
- test-python
- test-ruby
- test-java
- test-typescript
- test-php
if: always()
runs-on: ubuntu-latest
steps:
Expand All @@ -249,4 +204,4 @@ jobs:
if printf '${{ toJSON(needs) }}' | grep --quiet --extended-regexp --ignore-case '"result": "(failure|cancelled)"'; then
printf "Tests failed or workflow cancelled:\n\n${{ toJSON(needs) }}"
exit 1
fi
fi
8 changes: 4 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ jobs:
s3_path_pairs: 'launchdarkly-releaser/java/code-signing-keyring.gpg = /home/runner/code-signing-keyring.gpg'
- name: Prepare secrets
run: |
./scripts/release/prepare.sh
./scripts/release/prepare.sh
- name: Build clients
run: |
export PATH=/opt/gradle/bin:/usr/local/go/bin:$HOME/.rubygems/bin:$PATH
export GEM_HOME=$HOME/.rubygems
java -XX:+PrintFlagsFinal -version | grep ThreadStackSize
make
# Verify that the generated client code can be built
make BUILD_TARGETS="go java javascript python ruby typescript-axios" build_clients
make BUILD_TARGETS="go java python ruby typescript-axios" build_clients
# This step will:
# * Push built clients to their respective Github repos
# * Tag those commits with the release version
Expand All @@ -77,11 +77,11 @@ jobs:
needs: release
strategy:
matrix:
repo: ['api-client-go', 'api-client-java', 'api-client-javascript', 'api-client-php', 'api-client-python', 'api-client-ruby', 'api-client-typescript']
repo: ['api-client-go', 'api-client-java', 'api-client-python', 'api-client-ruby', 'api-client-typescript']
steps:
- uses: ncipollo/release-action@v1.14.0
with:
repo: ${{ matrix.repo }}
token: ${{ secrets.BOT_TOKEN }}
tag: v${{ inputs.releaseVersion }}
tag: v${{ inputs.releaseVersion }}
body: ${{ inputs.changeLog }}
22 changes: 0 additions & 22 deletions .ldrelease/build.sh

This file was deleted.

24 changes: 0 additions & 24 deletions .ldrelease/config.yml

This file was deleted.

38 changes: 0 additions & 38 deletions .ldrelease/prepare.sh

This file was deleted.

11 changes: 0 additions & 11 deletions .ldrelease/publish-dry-run.sh

This file was deleted.

18 changes: 0 additions & 18 deletions .ldrelease/publish.sh

This file was deleted.

17 changes: 0 additions & 17 deletions .ldrelease/secrets.properties

This file was deleted.

2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @launchdarkly/team-enterprise
* @launchdarkly/team-fm-next
51 changes: 24 additions & 27 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@ SHELL = /bin/bash

LD_RELEASE_VERSION ?= 0.0.1-SNAPSHOT

GENERATOR_VERSION=7.16.0
# IMPORTANT: Whenever updating this generator version, check if the ApiClient mustache files need corresponding updates.
# We have copied of these into the swagger-codegen-templates directory. Look for code blocks notated by CUSTOM-START and CUSTOM-END.
# - Go: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/go/client.mustache
# - Java: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache
# - Python: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/python/api_client.mustache
# - Ruby: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache
# - Typescript: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache
GENERATOR_VERSION=7.18.0
GENERATOR_JAR=openapi-generator-cli-${GENERATOR_VERSION}.jar
GENERATOR_DOWNLOAD_URL=https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/${GENERATOR_VERSION}/${GENERATOR_JAR}

OPENAPI_JSON_URL=https://app.launchdarkly.com/api/v2/openapi.json
LATEST_API_VERSION=20240415 # the API version (for the LD-API-Version header value) corresponding to what is specified in this OpenAPI spec

API_TARGETS ?= \
go \
java \
javascript \
php \
python \
ruby \
typescript-axios
Expand Down Expand Up @@ -41,7 +47,9 @@ SAMPLES_PATH ?= ./samples

# The following variables define any special command-line parameters that need to be passed
# to openapi-generator for each language/platform.
CODEGEN_PARAMS_go = --additional-properties=packageName=ldapi \
CODEGEN_PARAMS_go = \
-t $(TEMPLATES_PATH)/go \
--additional-properties=packageName=ldapi \
--additional-properties=disallowAdditionalPropertiesIfNotPresent=false \
--additional-properties=generateInterfaces=true \
--additional-properties=apiNameSuffix=Api \
Expand All @@ -51,8 +59,7 @@ CODEGEN_PARAMS_go = --additional-properties=packageName=ldapi \
--additional-properties=developerOrganization=LaunchDarkly \
--additional-properties=developerOrganizationUrl=https://launchdarkly.com \
--additional-properties=packageVersion=$(firstword $(subst ., ,$(TAG))) \
-t $(TEMPLATES_PATH)/go

--additional-properties=launchDarklyApiVersion=${LATEST_API_VERSION}
CODEGEN_PARAMS_java = \
-t $(TEMPLATES_PATH)/java \
--group-id com.launchdarkly \
Expand All @@ -70,42 +77,32 @@ CODEGEN_PARAMS_java = \
--additional-properties=scmUrl="https://github.com/launchdarkly/api-client-java" \
--additional-properties=scmConnection='scm:git:git://github.com/launchdarkly/api-client-java.git' \
--additional-properties=scmDeveloperConnection='scm:git:ssh:git@github.com:launchdarkly/api-client-java.git' \
--additional-properties=gradleProperties=systemProp.org.gradle.internal.http.connectionTimeout=300000$$'\n'systemProp.org.gradle.internal.http.socketTimeout=300000$$'\n'org.gradle.jvmargs=-Xss2m
CODEGEN_PARAMS_javascript = \
-t $(TEMPLATES_PATH)/javascript \
--additional-properties=projectName=launchdarkly-api \
--additional-properties=projectVersion=$(TAG) \
--additional-properties=projectDescription="Build custom integrations with the LaunchDarkly REST API" \
--additional-properties=moduleName=LaunchDarklyApi
CODEGEN_PARAMS_php = \
--additional-properties=packagePath=LaunchDarklyApi \
--additional-properties=composerVendorName=launchdarkly \
--additional-properties=composerProjectName=api-client-php \
--additional-properties=invokerPackage=LaunchDarklyApi \
--git-user-id=launchdarkly \
--git-repo-id=api-client-php
--additional-properties=gradleProperties=systemProp.org.gradle.internal.http.connectionTimeout=300000$$'\n'systemProp.org.gradle.internal.http.socketTimeout=300000$$'\n'org.gradle.jvmargs=-Xss2m \
--additional-properties=launchDarklyApiVersion=${LATEST_API_VERSION}
CODEGEN_PARAMS_python = \
--additional-properties=packageName=launchdarkly_api \
--additional-properties=packageVersion=$(TAG) \

--additional-properties=launchDarklyApiVersion=${LATEST_API_VERSION}
CODEGEN_PARAMS_typescript-axios = \
-t $(TEMPLATES_PATH)/typescript \
--additional-properties=npmName=launchdarkly-api-typescript \
--additional-properties=npmVersion=$(TAG) \
--additional-properties=supportsES6=true \
--additional-properties=axiosVersion=^1.13.1
--additional-properties=axiosVersion=^1.13.1 \
--additional-properties=launchDarklyApiVersion=${LATEST_API_VERSION}
CODEGEN_PARAMS_ruby = \
--additional-properties=moduleName=LaunchDarklyApi \
--additional-properties=gemName=launchdarkly_api \
--additional-properties=gemVersion=$(TAG) \
-t $(TEMPLATES_PATH)/ruby \
--additional-properties=moduleName=LaunchDarklyApi \
--additional-properties=gemName=launchdarkly_api \
--additional-properties=gemVersion=$(TAG) \
--additional-properties=launchDarklyApiVersion=${LATEST_API_VERSION}

SAMPLE_FILE_go = main.go
SAMPLE_FILE_javascript = index.js
SAMPLE_FILE_python = main.py
SAMPLE_FILE_ruby = main.rb
SAMPLE_FILE_typescript-axios = index.ts

SAMPLE_FORMAT_go = go
SAMPLE_FORMAT_javascript = js
SAMPLE_FORMAT_python = python
SAMPLE_FORMAT_ruby = ruby
SAMPLE_FORMAT_typescript-axios = ts
Expand Down
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,4 @@ Server/client code for the API can be automatically generated. To generate the c

## How releases work

This project is set up (via the files in `.ldrelease`) to work with LaunchDarkly's internal Releaser tool. Running a release via Releaser will execute the required `make` targets in the right order, sandboxed in a Docker container that contains all the necessary build tools. You can also do a "dry run" in Releaser, which does all of the _build_ steps and provides you with the build products, but does not push anything to GitHub or to package managers.

That is the preferred way of doing releases, but the `make` targets can also be run locally if necessary, as long as your local environment has all of the necessary tools installed (as defined by the Docker image selected in `.ldrelease/config.yml` and anything else that's installed in `.ldrelease/prepare.sh`). Here are more details about what they do:

* `make load_prior_targets`: Sets up the source repos for each client repository (such as `api-client-go`) as git submodules of the `targets` directory.
* `make all`: Generates the API spec, runs the OpenAPI code generator to create the code for each API client, and copies the generated code into the submodules in `targets`.
* `make build_clients`: Verifies that the generated code for each client can actually be built as a package. This runs the script for each client that is in `scripts/build`.
* `make push`: Pushes the changes in the submodules to the client repositories.
* `make push_dry_run`: Simulates what the result of `make push` would be.
* `make publish`: Pushes the client code to package managers, for platforms where this is applicable (such as NPM for the JavaScript clients). This runs the script for each client that is in `scripts/release`, if any.
* `make publish_dry_run`: Simulates what the result of `make publish` would be.This runs the script for each client that is in `scripts/build`, if any.

Or, if you just want to look at the generated code locally, run `make targets_docker` which is equivalent to `make all` but uses a Docker container, so that the only tool you need to have installed locally is Docker. The output will appear in `./targets`. This is a convenient way to validate any local changes that relate to code generation. If you are also making changes that affect how the client code is packaged or published, it is better to use the slower but more comprehensive method of a Releaser dry run.

When running any `make` targets locally, set the environment variable `$LD_RELEASE_VERSION` to the version you are releasing, such as "6.0.0". It is set automatically when releases are run through Releaser.
This project is set up to use [Github Actions](https://github.com/launchdarkly/ld-openapi-private/actions/workflows/release.yml) to release new versions.
Loading
Loading