Skip to content

Commit 9f8c269

Browse files
authored
task: add missing documentation for manual breaking releases (#238)
1 parent bfb406e commit 9f8c269

File tree

13 files changed

+13
-134
lines changed

13 files changed

+13
-134
lines changed

tools/releaser/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@ In situations when breaking changes are present automation will recognize them a
4545
- Replace all occurrences of the Major version in the repository
4646
- Generate breaking changes file
4747

48+
### Manual Breaking Changes Release
49+
50+
When introducing breaking changes outside generation process we need to manually run script:
51+
52+
1. Run
53+
54+
`make update-version`
55+
56+
2. Add breaking changes information to `./breaking _changes/{major_version}`
57+
3. Run `npm run format` to ensure that file contains correct release notes.
58+
4. Commit all the changes.
59+
4860
## Release Notes
4961

5062
If the release contains breaking changes (it is a major release)

tools/releaser/breaking_changes/v20230201002.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

tools/releaser/breaking_changes/v20230201003.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

tools/releaser/breaking_changes/v20230201004.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

tools/releaser/breaking_changes/v20230201005.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

tools/releaser/breaking_changes/v20230201006.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

tools/releaser/breaking_changes/v20230201007.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

tools/releaser/breaking_changes/v20230201008.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

tools/releaser/breaking_changes/v20231001001.md

Whitespace-only changes.

tools/releaser/breaking_changes/v20231001002.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)