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.

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

feat: [CPT] I can read how to write process tests #4270

Merged
merged 4 commits into from
Sep 17, 2024
Merged

feat: [CPT] I can read how to write process tests #4270

merged 4 commits into from
Sep 17, 2024

Conversation

saig0
Copy link
Member

@saig0 saig0 commented Sep 9, 2024

Description

Adds a new reference documentation for the new Camunda Process Test Java library. It describes how to install and use the library to write process tests. Take inspiration from the Zeebe Process Test documentation.

The new documentation is added to the sidebar under: API & Tools > Testing > Camunda Process Test.

closes #3921

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).
  • I included my new page in the sidebar file(s).

Copy link
Contributor

github-actions bot commented Sep 9, 2024

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/apis-tools/testing/assertions.md
  • docs/apis-tools/testing/connectors.md
  • docs/apis-tools/testing/getting-started.md
  • docs/apis-tools/testing/utilities.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@saig0 saig0 added component:zeebe Issues related with Zeebe project target:8.6 Issues included in the 8.6 release labels Sep 9, 2024
@saig0 saig0 added the deploy Stand up a temporary docs site with this PR label Sep 9, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs September 9, 2024 12:50 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs September 9, 2024 13:38 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs September 10, 2024 13:13 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs September 11, 2024 12:27 Destroyed
Add reference documentation for the new Camunda Process Test (CPT) library.

Add the documentation under `API & Tools > Testing > Camunda Process Test`.
@saig0 saig0 marked this pull request as ready for review September 16, 2024 05:10
@saig0 saig0 requested review from remcowesterhoud and a team September 16, 2024 05:10
@github-actions github-actions bot temporarily deployed to camunda-docs September 16, 2024 05:18 Destroyed
@saig0
Copy link
Member Author

saig0 commented Sep 16, 2024

The pages to review are under the section: https://preview.docs.camunda.cloud/pr-4270/docs/next/apis-tools/testing/getting-started/

Copy link
Contributor

@remcowesterhoud remcowesterhoud left a comment

Choose a reason for hiding this comment

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

Just some small things, otherwise LGTM 🚀

docs/apis-tools/testing/getting-started.md Outdated Show resolved Hide resolved
docs/apis-tools/testing/assertions.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to camunda-docs September 16, 2024 15:47 Destroyed
@saig0 saig0 merged commit a24cc5e into main Sep 17, 2024
7 checks passed
@saig0 saig0 deleted the 3921-cpt-ref branch September 17, 2024 07:16
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR target:8.6 Issues included in the 8.6 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

[CPT] I can read how to write process tests
3 participants