@allthings/cloud-toolkit 3.2.4-beta.1 → 3.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -7
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,26 +1,32 @@
|
|
|
1
1
|
# cloud-toolkit
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
Standardizes the setup of aws, Datadog and other things
|
|
3
4
|
|
|
4
5
|
## Available functions
|
|
6
|
+
|
|
5
7
|
### parameter store
|
|
8
|
+
|
|
6
9
|
| function | parameters | description |
|
|
7
|
-
|
|
10
|
+
| ---------- | --------------------------------------- | ------------------------------------------------------------------------------ |
|
|
8
11
|
| getSecret | parameter<br/>defaultValue (optional) | Retrieves a single secret from parameter store by providing the path |
|
|
9
12
|
| getSecrets | parameters<br/>defaultValues (optional) | Retrieves multiple secrets from parameter store by providing an array of paths |
|
|
10
13
|
|
|
11
14
|
### ses
|
|
15
|
+
|
|
12
16
|
| function | parameters | description |
|
|
13
|
-
|
|
17
|
+
| -------- | ---------- | ---------------------------------------------- |
|
|
14
18
|
| sendMail | options | Sends an email via SES or provided SMTP config |
|
|
15
19
|
|
|
16
20
|
### lambda
|
|
21
|
+
|
|
17
22
|
| function | parameters | description |
|
|
18
|
-
|
|
23
|
+
| ------------ | -------------------------- | ---------------------------------------------------- |
|
|
19
24
|
| invokeLambda | invocationType<br/>payload | Invokes set lambda with invocations type and payload |
|
|
20
25
|
|
|
21
26
|
### dynamodb
|
|
27
|
+
|
|
22
28
|
| function | parameters | description |
|
|
23
|
-
|
|
29
|
+
| --------------- | ------------------------------------ | -------------------------------------------------------- |
|
|
24
30
|
| batchWriteItems | table<br/>items | Creates multiple item in a defined table |
|
|
25
31
|
| deleteItem | table<br/>key<br/>options (optional) | Deletes database item from defined table by given key |
|
|
26
32
|
| getItem | table<br/>key<br/>options (optional) | Returns item from Database by defined table and key |
|
|
@@ -30,12 +36,56 @@ Standardizes the setup of aws, datadog and other things
|
|
|
30
36
|
| updateItem | table<br/>key<br/>options (optional) | Updates item in database by provided table and given key |
|
|
31
37
|
|
|
32
38
|
### sqs
|
|
39
|
+
|
|
33
40
|
| function | parameters | description |
|
|
34
|
-
|
|
41
|
+
| --------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
|
35
42
|
| deleteQueueItem | queueUrl<br/>receiptHandle | Deletes item from queue |
|
|
36
43
|
| getQueueItems | queueUrl<br/>maxNumberOfMessages (optional) | Retrieves items from queue |
|
|
37
44
|
| getQueueUrl | queueName | Returns queue url which is needed for all other requests |
|
|
38
45
|
| sendMessage | queueUrl<br/>message<br/>messageAttributes(optional)<br/>messageDelay(optional) | Creates an item in the queue |
|
|
39
46
|
|
|
40
47
|
### logger
|
|
41
|
-
|
|
48
|
+
|
|
49
|
+
A winston instance will be created with default log levels https://github.com/winstonjs/winston?tab=readme-ov-file#logging
|
|
50
|
+
|
|
51
|
+
## Releasing pre-release versions
|
|
52
|
+
|
|
53
|
+
This project uses [semantic-release](https://semantic-release.gitbook.io/semantic-release/) with support for pre-release channels via dedicated branches.
|
|
54
|
+
|
|
55
|
+
| Branch | npm dist-tag | Example version |
|
|
56
|
+
| ------- | ------------ | --------------- |
|
|
57
|
+
| `next` | `next` | `1.2.0-next.1` |
|
|
58
|
+
| `beta` | `beta` | `1.2.0-beta.1` |
|
|
59
|
+
| `alpha` | `alpha` | `1.2.0-alpha.1` |
|
|
60
|
+
|
|
61
|
+
### How to publish a pre-release
|
|
62
|
+
|
|
63
|
+
1. **Create or check out the target branch** from the commit you want to release:
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
git checkout -b beta # or alpha / next
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
2. **Push the branch** to trigger the CI pipeline:
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
git push --force origin HEAD:beta # or alpha / next
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
The pipeline will automatically run `semantic-release`, which detects the branch name, bumps the version with the appropriate pre-release tag, and publishes it to npm under the matching dist-tag. Check [Actions page](https://github.com/allthings/cloud-toolkit/actions) for the release logs.
|
|
76
|
+
|
|
77
|
+
3. **Install the pre-release** in another project:
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
npm install @allthings/cloud-toolkit@beta # or @alpha / @next
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
or use exact release (check [versions on npm](https://www.npmjs.com/package/@allthings/cloud-toolkit?activeTab=versions)):
|
|
84
|
+
|
|
85
|
+
```sh
|
|
86
|
+
npm install @allthings/cloud-toolkit@x.x.x-beta.x
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
4. **Promote to stable** – once the pre-release is validated, create a PR form your target branch.
|
|
90
|
+
|
|
91
|
+
> **Note:** commits on pre-release or target branches must still follow the [Conventional Commits](https://www.conventionalcommits.org/) specification so that semantic-release can determine the correct version bump.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@allthings/cloud-toolkit",
|
|
3
|
-
"version": "3.2.4
|
|
3
|
+
"version": "3.2.4",
|
|
4
4
|
"description": "",
|
|
5
5
|
"author": "Allthings GmbH",
|
|
6
6
|
"keywords": [
|
|
@@ -55,12 +55,12 @@
|
|
|
55
55
|
"serve": "npx serve -l 3333"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@aws-sdk/client-dynamodb": "^3.
|
|
59
|
-
"@aws-sdk/client-lambda": "^3.
|
|
60
|
-
"@aws-sdk/client-sesv2": "^3.
|
|
61
|
-
"@aws-sdk/client-sqs": "^3.
|
|
62
|
-
"@aws-sdk/client-ssm": "^3.
|
|
63
|
-
"@aws-sdk/lib-dynamodb": "^3.
|
|
58
|
+
"@aws-sdk/client-dynamodb": "^3.1012.0",
|
|
59
|
+
"@aws-sdk/client-lambda": "^3.1012.0",
|
|
60
|
+
"@aws-sdk/client-sesv2": "^3.1012.0",
|
|
61
|
+
"@aws-sdk/client-sqs": "^3.1012.0",
|
|
62
|
+
"@aws-sdk/client-ssm": "^3.1012.0",
|
|
63
|
+
"@aws-sdk/lib-dynamodb": "^3.1012.0",
|
|
64
64
|
"bottleneck": "^2.19.5",
|
|
65
65
|
"cross-fetch": "^4.1.0",
|
|
66
66
|
"nodemailer": "^8.0.0",
|