@rentman/rm-core 59.3.1 → 59.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/rm-core.js +1 -1
- package/package.json +1 -1
- package/readme.md +29 -36
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,49 +1,42 @@
|
|
|
1
1
|
# Running a local test version
|
|
2
2
|
1. Make changes
|
|
3
3
|
2. run `npm run bundle-dev`
|
|
4
|
-
3. copy `dist` folder to
|
|
5
|
-
|
|
6
|
-
- App: `<project>/node_modules/@rentman/rm-core/`
|
|
4
|
+
3. copy `dist` folder to `<project>/node_modules/@rentman/rm-core/`
|
|
5
|
+
4. Delete the Angular build cache (`.angular`) folder before rebuilding
|
|
7
6
|
|
|
8
|
-
#
|
|
7
|
+
# Releasing
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
## Production versions
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
2. Report changes in changelog
|
|
14
|
-
3. Commit your changes
|
|
15
|
-
4. Update version in package.json and core.ts
|
|
16
|
-
- Note! For consistency consider using `npm version` with appropriate flags and options
|
|
17
|
-
5. Push commits and tags
|
|
18
|
-
6. run `npm publish`
|
|
19
|
-
|
|
20
|
-
## How to use `npm version` command
|
|
21
|
-
|
|
22
|
-
`npm version <options>` command automatically creates
|
|
23
|
-
- commit
|
|
24
|
-
- version tag
|
|
25
|
-
- modifies both the `package.json` and `package-lock.json`
|
|
26
|
-
|
|
27
|
-
> Note! You cannot have uncommited changes in your repo for this
|
|
28
|
-
> otherwise you'll get `npm error Git working directory not clean` error.
|
|
11
|
+
For stable releases to master:
|
|
29
12
|
|
|
30
|
-
|
|
13
|
+
1. Go to [Release workflow](https://github.com/rentmanpublic/frontend-core/actions/workflows/release.yml)
|
|
14
|
+
2. Click "Run workflow"
|
|
15
|
+
3. Select version bump type:
|
|
16
|
+
- `major` – incompatible / breaking changes
|
|
17
|
+
- `minor` – adding functionality in a backward compatible manner
|
|
18
|
+
- `patch` – backward compatible changes / bug fixes
|
|
19
|
+
4. Run the workflow
|
|
31
20
|
|
|
32
|
-
|
|
21
|
+
This will publish to npm with the `latest` tag and create a git tag (e.g., `v59.4.0`).
|
|
33
22
|
|
|
34
|
-
|
|
35
|
-
- `minor` – adding functionality in a backward compatible manner
|
|
36
|
-
- `patch` – backward compatible changes / bug fixes
|
|
23
|
+
## Prereleases (Testing / PoC versions)
|
|
37
24
|
|
|
38
|
-
|
|
39
|
-
> Run `npm version patch -m "Bump version to %s"`
|
|
40
|
-
> where the %s will be replaced with the version number created
|
|
25
|
+
For testing versions from feature branches:
|
|
41
26
|
|
|
42
|
-
|
|
27
|
+
1. Go to [Prerelease workflow](https://github.com/rentmanpublic/frontend-core/actions/workflows/prerelease.yml)
|
|
28
|
+
2. Click "Run workflow"
|
|
29
|
+
3. Select the **branch** you want to release from
|
|
30
|
+
4. Enter a prerelease identifier (e.g., `RM4-12345`, `beta`, `feature-x`)
|
|
31
|
+
5. Run the workflow
|
|
43
32
|
|
|
44
|
-
|
|
33
|
+
This will:
|
|
34
|
+
- Create a version like `59.3.0-RM4-12345` (based on the last git tag)
|
|
35
|
+
- Publish to npm with a custom tag (e.g., `RM4-12345`)
|
|
36
|
+
- Commit and tag on your branch (e.g., `v59.3.0-RM4-12345`)
|
|
37
|
+
- Auto-increment if tag exists: `59.3.0-RM4-12345-02`, `59.3.0-RM4-12345-03`, etc.
|
|
45
38
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
39
|
+
To install a prerelease:
|
|
40
|
+
```bash
|
|
41
|
+
npm install @rentman/rm-core@RM4-12345
|
|
42
|
+
```
|