Skip to content

Commit 67cbd27

Browse files
roxblnfkroxblnfk
committed
Add readme; rename the package to temporal-php/support
1 parent f367291 commit 67cbd27

23 files changed

Lines changed: 129 additions & 60 deletions

‎README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<div align="center">
2+
<h1 align="center">Temporal PHP Support</h1>
3+
<div>Enhance your development experience with Temporal</div>
4+
</div>
5+
6+
<br />
7+
8+
The package includes attributes, helpers, factories, interfaces, interceptors,
9+
etc. to enhance the developer experience when using the [Temporal PHP SDK](https://github.com/temporalio/sdk-php).
10+
11+
12+
- [Installation](#installation)
13+
- [Usage](#usage)
14+
- [Contributing](#contributing)
15+
16+
## Installation
17+
18+
To install the package in your PHP application, add it as a dev dependency
19+
to your project using Composer:
20+
21+
```bash
22+
composer require temporal-php/support
23+
```
24+
25+
[![PHP](https://img.shields.io/packagist/php-v/temporal-php/support.svg?style=flat-square&logo=php)](https://packagist.org/packages/temporal-php/support)
26+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/temporal-php/support.svg?style=flat-square&logo=packagist)](https://packagist.org/packages/temporal-php/support)
27+
[![License](https://img.shields.io/packagist/l/temporal-php/support.svg?style=flat-square)](LICENSE.md)
28+
[![Total Downloads](https://img.shields.io/packagist/dt/temporal-php/support.svg?style=flat-square)](https://packagist.org/packages/temporal-php/support)
29+
30+
31+
## Usage
32+
33+
### Activity and Worker factories
34+
35+
### VirtualPromise interface
36+
37+
### Attributes
38+
39+
## Contributing
40+
41+
We believe in the power of community-driven development. Here's how you can contribute:
42+
43+
- **Report Bugs:** Encounter a glitch? Let us know on our [issue tracker](https://github.com/temporal-php/support/issues).
44+
- **Feature Suggestions:** Have ideas to improve the package? [Create a feature request](https://github.com/temporal-php/support/issues)!
45+
- **Code Contributions:** Submit a pull request to help us improve the codebase. You can find a list of
46+
issues labeled "help wanted" [here](https://github.com/temporal-php/support/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
47+
- **Spread the Word:** Share your experience with the package on social media and encourage others to contribute.
48+
- **Donate:** Support our work by becoming a patron or making a one-time donation
49+
[![roxblnfk](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Droxblnfk%26type%3Dpatrons&label=roxblnfk&style=flat-square)](https://patreon.com/roxblnfk)
50+
[![butschster](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dbutschster%26type%3Dpatrons&label=butschster&style=flat-square)](https://patreon.com/butschster)
51+
52+
53+
54+
55+
<!--
56+
57+
Quality badges:
58+
59+
[![Tests Status](https://img.shields.io/github/actions/workflow/status/temporal-php/support/testing.yml?label=tests&style=flat-square)](https://github.com/temporal-php/support/actions/workflows/testing.yml?query=workflow%3Atesting%3Amaster)
60+
[![Dependency status](https://php.package.health/packages/temporal-php/support/dev-master/status.svg)](https://php.package.health/packages/temporal-php/support/dev-master)
61+
62+
# (tests coverage)
63+
# (types coverage)
64+
# (psalm level)
65+
# (static analysis)
66+
# (mutation)
67+
# (scrutinizer score)
68+
# (code style)
69+
-->

‎composer.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "temporal-php/sugar",
2+
"name": "temporal-php/support",
33
"type": "library",
44
"license": "MIT",
55
"description": "Helpers that simplify working with the Temporal PHP SDK",
@@ -16,12 +16,12 @@
1616
],
1717
"autoload": {
1818
"psr-4": {
19-
"Temporal\\Sugar\\": "src/"
19+
"Temporal\\Support\\": "src/"
2020
}
2121
},
2222
"autoload-dev": {
2323
"psr-4": {
24-
"Temporal\\Sugar\\Tests\\": "tests/"
24+
"Temporal\\Support\\Tests\\": "tests/"
2525
}
2626
},
2727
"funding": [

‎src/Attribute/RetryPolicy.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Attribute;
5+
namespace Temporal\Support\Attribute;
66

77
use DateInterval;
8-
use Temporal\Sugar\Internal\Attribute\AttributeForActivity;
9-
use Temporal\Sugar\Internal\Attribute\AttributeForWorkflow;
8+
use Temporal\Support\Internal\Attribute\AttributeForActivity;
9+
use Temporal\Support\Internal\Attribute\AttributeForWorkflow;
1010
use Throwable;
1111

1212
#[\Attribute(\Attribute::TARGET_CLASS)]

‎src/Attribute/TaskQueue.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Attribute;
5+
namespace Temporal\Support\Attribute;
66

7-
use Temporal\Sugar\Internal\Attribute\AttributeForActivity;
8-
use Temporal\Sugar\Internal\Attribute\AttributeForWorkflow;
7+
use Temporal\Support\Internal\Attribute\AttributeForActivity;
8+
use Temporal\Support\Internal\Attribute\AttributeForWorkflow;
99

1010
#[\Attribute(\Attribute::TARGET_CLASS)]
1111
final class TaskQueue implements AttributeForWorkflow, AttributeForActivity

‎src/Factory/ActivityStub.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Factory;
5+
namespace Temporal\Support\Factory;
66

77
use DateInterval;
88
use Temporal\Activity\ActivityOptions;
99
use Temporal\Internal\Workflow\ActivityProxy;
10-
use Temporal\Sugar\Attribute\RetryPolicy;
11-
use Temporal\Sugar\Attribute\TaskQueue;
12-
use Temporal\Sugar\Internal\Attribute\AttributeCollection;
13-
use Temporal\Sugar\Internal\Attribute\AttributeForActivity;
14-
use Temporal\Sugar\Internal\Attribute\AttributeReader;
15-
use Temporal\Sugar\Internal\RetryOptions;
10+
use Temporal\Support\Attribute\RetryPolicy;
11+
use Temporal\Support\Attribute\TaskQueue;
12+
use Temporal\Support\Internal\Attribute\AttributeCollection;
13+
use Temporal\Support\Internal\Attribute\AttributeForActivity;
14+
use Temporal\Support\Internal\Attribute\AttributeReader;
15+
use Temporal\Support\Internal\RetryOptions;
1616
use Temporal\Workflow;
1717
use Throwable;
1818

‎src/Factory/WorkflowStub.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Factory;
5+
namespace Temporal\Support\Factory;
66

77
use DateInterval;
88
use Temporal\Client\WorkflowClientInterface;
99
use Temporal\Client\WorkflowOptions;
1010
use Temporal\Common\IdReusePolicy;
1111
use Temporal\Internal\Client\WorkflowProxy;
1212
use Temporal\Internal\Workflow\ChildWorkflowProxy;
13-
use Temporal\Sugar\Attribute\RetryPolicy;
14-
use Temporal\Sugar\Attribute\TaskQueue;
15-
use Temporal\Sugar\Internal\Attribute\AttributeCollection;
16-
use Temporal\Sugar\Internal\Attribute\AttributeForWorkflow;
17-
use Temporal\Sugar\Internal\Attribute\AttributeReader;
18-
use Temporal\Sugar\Internal\RetryOptions;
13+
use Temporal\Support\Attribute\RetryPolicy;
14+
use Temporal\Support\Attribute\TaskQueue;
15+
use Temporal\Support\Internal\Attribute\AttributeCollection;
16+
use Temporal\Support\Internal\Attribute\AttributeForWorkflow;
17+
use Temporal\Support\Internal\Attribute\AttributeReader;
18+
use Temporal\Support\Internal\RetryOptions;
1919
use Temporal\Workflow;
2020
use Temporal\Workflow\ChildWorkflowCancellationType as ChildCancelType;
2121
use Temporal\Workflow\ParentClosePolicy;

‎src/Internal/Attribute/AttributeCollection.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Internal\Attribute;
5+
namespace Temporal\Support\Internal\Attribute;
66

77
/**
88
* @internal

‎src/Internal/Attribute/AttributeForActivity.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Internal\Attribute;
5+
namespace Temporal\Support\Internal\Attribute;
66

77
/**
88
* @internal
9-
* @psalm-internal Temporal\Sugar
9+
* @psalm-internal Temporal\Support
1010
*/
1111
interface AttributeForActivity
1212
{

‎src/Internal/Attribute/AttributeForWorkflow.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Internal\Attribute;
5+
namespace Temporal\Support\Internal\Attribute;
66

77
/**
88
* @internal
9-
* @psalm-internal Temporal\Sugar
9+
* @psalm-internal Temporal\Support
1010
*/
1111
interface AttributeForWorkflow
1212
{

‎src/Internal/Attribute/AttributeReader.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
declare(strict_types=1);
44

5-
namespace Temporal\Sugar\Internal\Attribute;
5+
namespace Temporal\Support\Internal\Attribute;
66

77
/**
88
* @internal

0 commit comments

Comments
 (0)