Skip to content

Commit ea1c755

Browse files
authored
chore(all): Allow scope all for all packages (#126)
1 parent 5cf1bef commit ea1c755

File tree

5 files changed

+32
-7
lines changed

5 files changed

+32
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ MIT, see [the LICENSE file](LICENSE).
186186

187187
## Contributing
188188

189-
Do you want to contribute to this project? Please take a look at our [contributing guideline](/docs/CONTRIBUTING.md) to know how you can help us build it.
189+
Do you want to contribute to this project? Please take a look at our [contributing guidelines](/docs/CONTRIBUTING.md) to know how you can help us build it. You can also check the [development guide](/docs/development.md) for information about local setup and the release process.
190190

191191
---
192192

docs/development.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
## Development
1+
# Development
22

33
To setup your local environment follow the next steps.
44

5-
### Requirements
5+
## Requirements
66

77
* Latest [Yarn Classic](https://classic.yarnpkg.com)
88
* NodeJS (Use version set on [.nvmrc](https://github.com/stackbuilders/assertive-ts/blob/master/.nvmrc))
99

10+
## Useful commands
11+
1012
### Install dependencies
1113

1214
```console
@@ -29,4 +31,18 @@ yarn lint
2931

3032
```console
3133
yarn test
32-
```
34+
```
35+
36+
## Release process
37+
38+
The release process is automated by [semantic-release](https://semantic-release.gitbook.io/semantic-release/), so please make sure that the first commit of any PR follows the [Conventional Commits standard](https://www.conventionalcommits.org/). Take a look at semantic-release documentation if you're not sure what type of commit you should use.
39+
40+
### Scopes
41+
42+
Scopes are optional on Conventional Commits, but we take advantange of them to specify the package a change is aimed for. The table below describes the the available scopes and what package they affect:
43+
44+
| Scope | Package | Commit example |
45+
| :-----: | :-------------------: | -------------------------------- |
46+
| `all` | All packages | feat(all): Upadate TypeScript |
47+
| `core` | `@assertive-ts/core` | fix(core): Boolean assertion bug |
48+
| `sinon` | `@assertive-ts/sinon` | fix(sinon): Spy assertion bug |

packages/core/.releaserc.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
"branches": ["main"],
44
"plugins": [
55
["@semantic-release/commit-analyzer", {
6-
"releaseRules": [{ "scope": "!core", "release": false }]
6+
"releaseRules": [
7+
{ "scope": "!all", "release": false },
8+
{ "scope": "!core", "release": false }
9+
]
710
}],
811
"@semantic-release/release-notes-generator",
912
"semantic-release-yarn",

packages/dom/.releaserc.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
"branches": ["main"],
44
"plugins": [
55
["@semantic-release/commit-analyzer", {
6-
"releaseRules": [{ "scope": "!dom", "release": false }]
6+
"releaseRules": [
7+
{ "scope": "!all", "release": false },
8+
{ "scope": "!dom", "release": false }
9+
]
710
}],
811
"@semantic-release/release-notes-generator",
912
"semantic-release-yarn",

packages/sinon/.releaserc.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
"branches": ["main"],
44
"plugins": [
55
["@semantic-release/commit-analyzer", {
6-
"releaseRules": [{ "scope": "!sinon", "release": false }]
6+
"releaseRules": [
7+
{ "scope": "!all", "release": false },
8+
{ "scope": "!sinon", "release": false }
9+
]
710
}],
811
"@semantic-release/release-notes-generator",
912
"semantic-release-yarn",

0 commit comments

Comments
 (0)