Skip to content

Commit e0c30ed

Browse files
committed
update readme to reflect the new release flow
1 parent 9db1768 commit e0c30ed

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,10 @@ The Onboarding module is designed to streamline various tasks related to user on
7777
- Generate screenshots tailored to the user's preferences and create a child theme using the provided name.
7878

7979
## Release Process
80-
### Local Release Preparation
80+
81+
Run the `Newfold Prepare Release` github action to automatically bump the version (either patch, minor or major version), and update build and language files all at once. It will create a PR with changed files for review. Using this workflow, we can skip all the manual steps below.
82+
83+
### Manual Release Preparation
8184

8285
1. **Checkout the trunk branch locally:**
8386
```bash
@@ -89,25 +92,28 @@ The Onboarding module is designed to streamline various tasks related to user on
8992
git pull origin trunk
9093
```
9194

95+
3. **Create release branch, where [x.y.z] is the new version (following Semantic Versioning):**
96+
```bash
97+
git branch release/[x.y.z]
98+
```
99+
92100
3. **Test for any breaking changes and highlight concerns:**
93101
- **Conduct thorough testing to ensure stability and functionality.**
94102
- Note any issues or concerns for further action.
95103

96104
4. **Increment Version via script**
97-
- run `npm run set-version-bump`
98-
- This will update the version number in required files, remove the old build, and create a fresh build.
99-
- Alternatively, update versions and rebuild manually:
100-
1. **Increment version following Semantic Versioning 2.0.0:**
105+
- Update versions and rebuild manually:
106+
1. **Increment version [x.y.z]**
101107
- Update version in:
102108
- `bootstrap.php`
103109
- `package.json`
104-
- `package-lock.json`
105110
- Run:
106111
```bash
107112
npm install
108113
npm run build
109114
```
110115
- Verify existence of `build/<new_version>` folder.
116+
- Remove previous release build files: `build/<old_version>` folder.
111117
- Update language files. Run: `composer run i18n`.
112118

113119
5. **Push changes to origin:**

0 commit comments

Comments
 (0)