Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add "Fully Supported" and definition to README #70

Closed
jwulf opened this issue Mar 18, 2024 · 1 comment
Closed

Add "Fully Supported" and definition to README #70

jwulf opened this issue Mar 18, 2024 · 1 comment
Assignees
@jwulf
Milestone
8.5.0

Comments

@jwulf
Copy link
Member

jwulf commented Mar 18, 2024 •
edited
Loading

What does "supported" mean?

This is the official supported-by-Camunda Nodejs SDK for Camunda Platform 8.

The Node.js SDK will not always support all features of Camunda Platform 8 immediately upon their release. Complete API coverage for a platform release will lag behind the platform release.

Prioritisation of implementing features is influenced by customer demand.
@jwulf jwulf self-assigned this Mar 18, 2024
@jwulf jwulf added this to the 8.5.0 milestone Mar 18, 2024
@MaxTru
Copy link

MaxTru commented Mar 28, 2024 •
edited
Loading

Thanks for initiating this.

Some notes:

  • Let's please not use the term fully supported because there is no such thing as fully / partly / 20% supported.
    • Essentially => we support Camunda 8 and supporting components as specified, where the specification is what we put into the docs.
    • Following that, it is sufficient to put the node-js SDK into docs.camunda.io and state "The SDK supports the following features / APIS / ...``

You can get an Enterprise Support agreement with Camunda and get technical support for using this SDK in development and production. With a support agreement, you can open tickets and get technical support on using the features that the SDK implements.

  • That is true, but I don't see the need to add a specific note about this in the docs (again, we support what is specified).

At the moment, we do not guarantee that the SDK will support all features of Camunda Platform 8 immediately upon their release.

Our goal with the SDK to support the features of a minor release within the minor release window. This means, for example, that all 8.5 features are enabled by this SDK before the 8.6 release.

That makes sense, and I think is worth highlighting.

Thanks!

jwulf added a commit that referenced this issue Apr 5, 2024
@jwulf
fix(repo): add note on "supported"
7187e92 
Fixes #70
@jwulf jwulf mentioned this issue Apr 5, 2024
Merged
jwulf added a commit that referenced this issue Apr 5, 2024
@jwulf
fix(repo): add note on "supported" (#107)
fc45d61 
Fixes #70
github-actions bot pushed a commit that referenced this issue Apr 5, 2024
@semantic-release-bot
chore(release): 8.5.0-alpha.2 [skip ci]
333ba8f 
# [8.5.0-alpha.2](v8.5.0-alpha.1...v8.5.0-alpha.2) (2024-04-05)

### Bug Fixes

* **repo:** add note on "supported" ([#107](#107)) ([fc45d61](fc45d61)), closes [#70](#70)
@jwulf jwulf closed this as completed Apr 5, 2024
jwulf added a commit that referenced this issue Apr 8, 2024
@jwulf @semantic-release-bot
Release 8.5.0 (#124)
87402d6 
* ci(repo): create npm publish workflow (#100)

* Remove-docs (#101)

* docs(repo): remove docs

* docs(repo): add docs folder to .gitignore

* ci(repo): update publish workflow (#102)

* ci(repo): configure renovate to run against alpha branch (#103)

* ci(repo): configure renovate to run against alpha branch

* ci(repo): add workflow step to merge to alpha from main on release

* chore(release): 8.5.0-alpha.1 [skip ci]

# [8.5.0-alpha.1](v8.4.0...v8.5.0-alpha.1) (2024-04-04)

### Features

* **oauth:** support optional scope in OAuth request ([#25](#25)) ([0451b80](0451b80))
* **operate:** add multitenant support and lossless Json parsing ([#82](#82)) ([cf49a71](cf49a71)), closes [#78](#78) [#67](#67)
* **repo:** add enhanced debug output for http errors ([#88](#88)) ([881b039](881b039)), closes [#87](#87)
* **tasklist:** add multitenant support to tasklist ([#85](#85)) ([46bb564](46bb564))
* **zeebe:** add MigrateProcessInstance ([#97](#97)) ([2a9a123](2a9a123)), closes [#49](#49)
* **zeebe:** implement deleteResource ([#73](#73)) ([0cd08b7](0cd08b7))
* **zeebe:** implement lossless parsing of job payload ([#95](#95)) ([57f3ea8](57f3ea8)), closes [#81](#81)
* **zeebe:** normalise useragent, thread config ([#94](#94)) ([c1c4211](c1c4211))
* **zeebe:** remove deployProcess method ([#71](#71)) ([6cb98f0](6cb98f0))

* test(repo): skip jest global setup for unit tests (#106)


Fixes #105

* build(repo): parallelise publish workflow

* build(repo): fix parallelisation

* fix(repo): add note on "supported" (#107)

Fixes #70

* chore(release): 8.5.0-alpha.2 [skip ci]

# [8.5.0-alpha.2](v8.5.0-alpha.1...v8.5.0-alpha.2) (2024-04-05)

### Bug Fixes

* **repo:** add note on "supported" ([#107](#107)) ([fc45d61](fc45d61)), closes [#70](#70)

* fix(repo): only git commit on npm publish success

* chore(release): 8.5.0-alpha.3 [skip ci]

# [8.5.0-alpha.3](v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05)

### Bug Fixes

* **repo:** only git commit on npm publish success ([9012764](9012764))

* chore(release): 8.5.0-alpha.3 [skip ci]

# [8.5.0-alpha.3](v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05)

### Bug Fixes

* **repo:** only git commit on npm publish success ([9012764](9012764))

* build(repo): configure semantic release (#109)

fixes #108

* fix(repo): use ts-patch to transform module mapping in output (#112)

* fix(repo): use ts-patch to transform module mapping in output

fixes #110

* build(repo): add missing tsconfig-paths

* chore(release): 8.5.0-alpha.4 [skip ci]

# [8.5.0-alpha.4](v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05)

### Bug Fixes

* **repo:** use ts-patch to transform module mapping in output ([#112](#112)) ([7efdcf3](7efdcf3)), closes [#110](#110)

* chore(release): 8.5.0-alpha.4 [skip ci]

# [8.5.0-alpha.4](v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05)

### Bug Fixes

* **repo:** use ts-patch to transform module mapping in output ([#112](#112)) ([7efdcf3](7efdcf3)), closes [#110](#110)

* ci(repo): parallelise tests and use npm install in CI (#116)

fixes #115

* Jwulf/issue114 (#117)

* fix(repo): use relative paths in source

fixes #114

* test(repo): fix relative path in jest setup

* test(repo): fix relative path to zeebe

* test(repo): convert tests to relative paths

* revert(github): remove spurious commitlint config file

* fix(repo): make fix type commits release a new package

* ci(repo): wrap long lines in commit messages

* ci(repo): wrap footer lines at 100 characters in semantic-release config

* ci(repo): break commit msgs to 100 chars via husky hook

* ci(repo): disable husky during semantic-release

* chore(release): 8.5.0-alpha.5 [skip ci]

# [8.5.0-alpha.5](v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07)

### Bug Fixes

* **repo:** make fix type commits release a new package ([ded83cf](ded83cf))

* chore(release): 8.5.0-alpha.5 [skip ci]

# [8.5.0-alpha.5](v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07)

### Bug Fixes

* **repo:** make fix type commits release a new package ([ded83cf](ded83cf))

* Issue118 (#119)

* test(repo): add smoke test and type surface tests
fixes #118
* ci(repo): run smoke test in CI
* fix(camunda8): respect OAuth disabled flag

* fix(issue118): add smoke test and type surface tests

* test(repo): add smoke test and type surface tests
fixes #118
* ci(repo): run smoke test in CI
* fix(camunda8): respect OAuth disabled flag

* release(repo): trigger a new release

* chore(release): 8.5.0-alpha.6 [skip ci]

# [8.5.0-alpha.6](v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08)

### Bug Fixes

* **issue118:** add smoke test and type surface tests ([fe0c709](fe0c709)), closes [#118](#118)

* chore(release): 8.5.0-alpha.6 [skip ci]

# [8.5.0-alpha.6](v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08)

### Bug Fixes

* **issue118:** add smoke test and type surface tests ([fe0c709](fe0c709)), closes [#118](#118)

* ci(repo): add CodeQL scanning (#120)

fixes #51

---------

Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
jwulf added a commit that referenced this issue Apr 8, 2024
@jwulf @semantic-release-bot
Merge changes from main back to alpha (#126)
ab662e6 
* Release 8.5.0 (#124)

* ci(repo): create npm publish workflow (#100)

* Remove-docs (#101)

* docs(repo): remove docs

* docs(repo): add docs folder to .gitignore

* ci(repo): update publish workflow (#102)

* ci(repo): configure renovate to run against alpha branch (#103)

* ci(repo): configure renovate to run against alpha branch

* ci(repo): add workflow step to merge to alpha from main on release

* chore(release): 8.5.0-alpha.1 [skip ci]

# [8.5.0-alpha.1](v8.4.0...v8.5.0-alpha.1) (2024-04-04)

### Features

* **oauth:** support optional scope in OAuth request ([#25](#25)) ([0451b80](0451b80))
* **operate:** add multitenant support and lossless Json parsing ([#82](#82)) ([cf49a71](cf49a71)), closes [#78](#78) [#67](#67)
* **repo:** add enhanced debug output for http errors ([#88](#88)) ([881b039](881b039)), closes [#87](#87)
* **tasklist:** add multitenant support to tasklist ([#85](#85)) ([46bb564](46bb564))
* **zeebe:** add MigrateProcessInstance ([#97](#97)) ([2a9a123](2a9a123)), closes [#49](#49)
* **zeebe:** implement deleteResource ([#73](#73)) ([0cd08b7](0cd08b7))
* **zeebe:** implement lossless parsing of job payload ([#95](#95)) ([57f3ea8](57f3ea8)), closes [#81](#81)
* **zeebe:** normalise useragent, thread config ([#94](#94)) ([c1c4211](c1c4211))
* **zeebe:** remove deployProcess method ([#71](#71)) ([6cb98f0](6cb98f0))

* test(repo): skip jest global setup for unit tests (#106)


Fixes #105

* build(repo): parallelise publish workflow

* build(repo): fix parallelisation

* fix(repo): add note on "supported" (#107)

Fixes #70

* chore(release): 8.5.0-alpha.2 [skip ci]

# [8.5.0-alpha.2](v8.5.0-alpha.1...v8.5.0-alpha.2) (2024-04-05)

### Bug Fixes

* **repo:** add note on "supported" ([#107](#107)) ([fc45d61](fc45d61)), closes [#70](#70)

* fix(repo): only git commit on npm publish success

* chore(release): 8.5.0-alpha.3 [skip ci]

# [8.5.0-alpha.3](v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05)

### Bug Fixes

* **repo:** only git commit on npm publish success ([9012764](9012764))

* chore(release): 8.5.0-alpha.3 [skip ci]

# [8.5.0-alpha.3](v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05)

### Bug Fixes

* **repo:** only git commit on npm publish success ([9012764](9012764))

* build(repo): configure semantic release (#109)

fixes #108

* fix(repo): use ts-patch to transform module mapping in output (#112)

* fix(repo): use ts-patch to transform module mapping in output

fixes #110

* build(repo): add missing tsconfig-paths

* chore(release): 8.5.0-alpha.4 [skip ci]

# [8.5.0-alpha.4](v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05)

### Bug Fixes

* **repo:** use ts-patch to transform module mapping in output ([#112](#112)) ([7efdcf3](7efdcf3)), closes [#110](#110)

* chore(release): 8.5.0-alpha.4 [skip ci]

# [8.5.0-alpha.4](v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05)

### Bug Fixes

* **repo:** use ts-patch to transform module mapping in output ([#112](#112)) ([7efdcf3](7efdcf3)), closes [#110](#110)

* ci(repo): parallelise tests and use npm install in CI (#116)

fixes #115

* Jwulf/issue114 (#117)

* fix(repo): use relative paths in source

fixes #114

* test(repo): fix relative path in jest setup

* test(repo): fix relative path to zeebe

* test(repo): convert tests to relative paths

* revert(github): remove spurious commitlint config file

* fix(repo): make fix type commits release a new package

* ci(repo): wrap long lines in commit messages

* ci(repo): wrap footer lines at 100 characters in semantic-release config

* ci(repo): break commit msgs to 100 chars via husky hook

* ci(repo): disable husky during semantic-release

* chore(release): 8.5.0-alpha.5 [skip ci]

# [8.5.0-alpha.5](v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07)

### Bug Fixes

* **repo:** make fix type commits release a new package ([ded83cf](ded83cf))

* chore(release): 8.5.0-alpha.5 [skip ci]

# [8.5.0-alpha.5](v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07)

### Bug Fixes

* **repo:** make fix type commits release a new package ([ded83cf](ded83cf))

* Issue118 (#119)

* test(repo): add smoke test and type surface tests
fixes #118
* ci(repo): run smoke test in CI
* fix(camunda8): respect OAuth disabled flag

* fix(issue118): add smoke test and type surface tests

* test(repo): add smoke test and type surface tests
fixes #118
* ci(repo): run smoke test in CI
* fix(camunda8): respect OAuth disabled flag

* release(repo): trigger a new release

* chore(release): 8.5.0-alpha.6 [skip ci]

# [8.5.0-alpha.6](v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08)

### Bug Fixes

* **issue118:** add smoke test and type surface tests ([fe0c709](fe0c709)), closes [#118](#118)

* chore(release): 8.5.0-alpha.6 [skip ci]

# [8.5.0-alpha.6](v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08)

### Bug Fixes

* **issue118:** add smoke test and type surface tests ([fe0c709](fe0c709)), closes [#118](#118)

* ci(repo): add CodeQL scanning (#120)

fixes #51

---------

Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>

* release: trigger a new release

* chore(release): 8.4.1 [skip ci]

## [8.4.1](v8.4.0...v8.4.1) (2024-04-08)

### Features

* **oauth:** support optional scope in OAuth request ([#25](#25)) ([0451b80](0451b80))
* **operate:** add multitenant support and lossless Json parsing ([#82](#82)) ([cf49a71](cf49a71)), closes [#78](#78) [#67](#67)
* **repo:** add enhanced debug output for http errors ([#88](#88)) ([881b039](881b039)), closes [#87](#87)
* **tasklist:** add multitenant support to tasklist ([#85](#85)) ([46bb564](46bb564))
* **zeebe:** add MigrateProcessInstance ([#97](#97)) ([2a9a123](2a9a123)), closes [#49](#49)
* **zeebe:** implement deleteResource ([#73](#73)) ([0cd08b7](0cd08b7))
* **zeebe:** implement lossless parsing of job payload ([#95](#95)) ([57f3ea8](57f3ea8)), closes [#81](#81)
* **zeebe:** normalise useragent, thread config ([#94](#94)) ([c1c4211](c1c4211))
* **zeebe:** remove deployProcess method ([#71](#71)) ([6cb98f0](6cb98f0))

* chore(release): 8.4.1 [skip ci]

## [8.4.1](v8.4.0...v8.4.1) (2024-04-08)

### Features

* **oauth:** support optional scope in OAuth request ([#25](#25)) ([0451b80](0451b80))
* **operate:** add multitenant support and lossless Json parsing ([#82](#82)) ([cf49a71](cf49a71)), closes [#78](#78) [#67](#67)
* **repo:** add enhanced debug output for http errors ([#88](#88)) ([881b039](881b039)), closes [#87](#87)
* **tasklist:** add multitenant support to tasklist ([#85](#85)) ([46bb564](46bb564))
* **zeebe:** add MigrateProcessInstance ([#97](#97)) ([2a9a123](2a9a123)), closes [#49](#49)
* **zeebe:** implement deleteResource ([#73](#73)) ([0cd08b7](0cd08b7))
* **zeebe:** implement lossless parsing of job payload ([#95](#95)) ([57f3ea8](57f3ea8)), closes [#81](#81)
* **zeebe:** normalise useragent, thread config ([#94](#94)) ([c1c4211](c1c4211))
* **zeebe:** remove deployProcess method ([#71](#71)) ([6cb98f0](6cb98f0))

---------

Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
github-actions bot pushed a commit that referenced this issue Apr 8, 2024
@semantic-release-bot
chore(release): 8.5.0 [skip ci]
afab179 
# [8.5.0](v8.4.1...v8.5.0) (2024-04-08)

### Bug Fixes

* **issue118:** add smoke test and type surface tests ([fe0c709](fe0c709)), closes [#118](#118)
* **repo:** add note on "supported" ([#107](#107)) ([fc45d61](fc45d61)), closes [#70](#70)
* **repo:** make fix type commits release a new package ([ded83cf](ded83cf))
* **repo:** only git commit on npm publish success ([9012764](9012764))
* **repo:** use ts-patch to transform module mapping in output ([#112](#112)) ([7efdcf3](7efdcf3)), closes [#110](#110)
github-actions bot pushed a commit that referenced this issue Apr 8, 2024
@semantic-release-bot
chore(release): 8.5.0 [skip ci]
666e3fe 
# [8.5.0](v8.4.1...v8.5.0) (2024-04-08)

### Bug Fixes

* **issue118:** add smoke test and type surface tests ([fe0c709](fe0c709)), closes [#118](#118)
* **repo:** add note on "supported" ([#107](#107)) ([fc45d61](fc45d61)), closes [#70](#70)
* **repo:** make fix type commits release a new package ([ded83cf](ded83cf))
* **repo:** only git commit on npm publish success ([9012764](9012764))
* **repo:** use ts-patch to transform module mapping in output ([#112](#112)) ([7efdcf3](7efdcf3)), closes [#110](#110)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jwulf jwulf

Labels
None yet
Projects
Developer Experience
Status: ✅ Done
Milestone
8.5.0
Development

No branches or pull requests
2 participants
@jwulf @MaxTru