Skip to content

Commit 5653aa6

Browse files
authored
chore: Updated versioning strategy and changesets config (#295)
* Add fixed versioning * Adding versioning docs * bump bare example version
1 parent c144ff4 commit 5653aa6

3 files changed

Lines changed: 20 additions & 5 deletions

File tree

.changeset/config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
}
88
],
99
"commit": false,
10-
"fixed": [],
10+
"fixed": [["react-native-ama/*"]],
1111
"linked": [],
1212
"access": "public",
1313
"baseBranch": "main",
1414
"updateInternalDependencies": "patch",
15+
"privatePackages": { "version": true, "tag": true },
1516
"ignore": []
1617
}

CONTRIBUTING.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ $ yarn test
2121

2222
```
2323

24+
### Versioning
25+
26+
We loosely follow [Semantic Versioning](https://semver.org/) and use the `changesets` tool to manage our versioning. That means:
27+
28+
Given a version number MAJOR.MINOR.PATCH, increment the:
29+
30+
MAJOR version when there is a fundamental and incompatible API changes
31+
MINOR version when you add functionality in a backward compatible manner or when a minor breaking changes is added
32+
PATCH version when you make backward compatible bug fixes
33+
34+
#### One Major and Minor version for all packages
35+
36+
We keep all our @react-native-ama/\* packages synced to the same version (One True Version). This means that if you make a change to one package that requires a new version, all packages will be bumped to the same version. We do this to reduce the number of dependent issues a consumer may have and prevent miss-matching package versions.
37+
38+
Here are more details on using and adding changesets:
39+
2440
### Using changesets
2541

2642
Our official release path is to use automation to perform the actual publishing of our packages. The steps are to:
@@ -29,9 +45,7 @@ Our official release path is to use automation to perform the actual publishing
2945
2. On merge of a PR our automation system opens a "Version Packages" PR.
3046
3. On merging the "Version Packages" PR, the automation system publishes the packages.
3147

32-
Here are more details:
33-
34-
### Add a changeset
48+
#### Add a changeset
3549

3650
When you would like to add a changeset (which creates a file indicating the type of change), in your branch/PR issue this command:
3751

examples/bare/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "amaexample",
3-
"version": "0.0.2",
3+
"version": "1.0.1",
44
"private": true,
55
"scripts": {
66
"android": "react-native run-android",

0 commit comments

Comments
 (0)