Skip to content

Commit

Permalink
chore(all): Allow scope all for all packages
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseLion committed Mar 18, 2024
1 parent 3a4c90b commit e6d563b
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ MIT, see [the LICENSE file](LICENSE).

## Contributing

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.
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.

---

Expand Down
22 changes: 19 additions & 3 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
## Development
# Development

To setup your local environment follow the next steps.

### Requirements
## Requirements

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

## Useful commands

### Install dependencies

```console
Expand All @@ -29,4 +31,18 @@ yarn lint

```console
yarn test
```
```

## Release process

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.

### Scopes

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:

| Scope | Package | Commit example |
| :-----: | :-------------------: | -------------------------------- |
| `all` | All packages | feat(all): Upadate TypeScript |
| `core` | `@assertive-ts/core` | fix(core): Boolean assertion bug |
| `sinon` | `@assertive-ts/sinon` | fix(sinon): Spy assertion bug |
5 changes: 4 additions & 1 deletion packages/core/.releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
"branches": ["main"],
"plugins": [
["@semantic-release/commit-analyzer", {
"releaseRules": [{ "scope": "!core", "release": false }]
"releaseRules": [
{ "scope": "!all", "release": false },
{ "scope": "!core", "release": false }
]
}],
"@semantic-release/release-notes-generator",
"semantic-release-yarn",
Expand Down
5 changes: 4 additions & 1 deletion packages/dom/.releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
"branches": ["main"],
"plugins": [
["@semantic-release/commit-analyzer", {
"releaseRules": [{ "scope": "!dom", "release": false }]
"releaseRules": [
{ "scope": "!all", "release": false },
{ "scope": "!dom", "release": false }
]
}],
"@semantic-release/release-notes-generator",
"semantic-release-yarn",
Expand Down
5 changes: 4 additions & 1 deletion packages/sinon/.releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
"branches": ["main"],
"plugins": [
["@semantic-release/commit-analyzer", {
"releaseRules": [{ "scope": "!sinon", "release": false }]
"releaseRules": [
{ "scope": "!all", "release": false },
{ "scope": "!sinon", "release": false }
]
}],
"@semantic-release/release-notes-generator",
"semantic-release-yarn",
Expand Down

0 comments on commit e6d563b

Please sign in to comment.