Skip to content

Commit 6f1ff13

Browse files
GreewilGreewil
authored
Merge pull request #35 from Greewil/handle_multiple_modules
Handle multiple modules
2 parents e825af0 + 3fffbf1 commit 6f1ff13

File tree

2 files changed

+140
-47
lines changed

2 files changed

+140
-47
lines changed

‎README.md‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,16 @@ To use vuh with your project you should first create .vuh file in root folder of
8585
[-q | --quiet] to show only version number (or errors messages if there are so).
8686

8787
[-pm=<project_module>] to use specified module of your mono repository project (instead of default).
88+
If you want to execute command for multiple project modules you can
89+
specify them separated with commas (f.e. '-pm=API,WEB').
90+
If you want to execute command for all project modules you can write '-pm=ALL'.
8891

8992
[--dont-use-git] don't use any git commands.
9093
In this case you should run vuh in root directory (which contains .vuh)
9194
or specify path to it using '--config-path=<path>' parameter.
9295

9396
[--config-dir=<path>] Search for .vuh configuration file in another directory.
94-
You dont need to specify it if you are working with git repository.
97+
You don't need to specify it if you are working with git repository.
9598
Suggesting to use this parameter with '--dont-use-git' parameter.
9699

97100
mv, main-version Show version of origin/MAIN_BRANCH_NAME.
@@ -102,6 +105,9 @@ To use vuh with your project you should first create .vuh file in root folder of
102105
This parameter overrides MAIN_BRANCH_NAME configuration variable from .vuh file.
103106

104107
[-pm=<project_module>] to use specified module of your mono repository project (instead of default).
108+
If you want to execute command for multiple project modules you can
109+
specify them separated with commas (f.e. '-pm=API,WEB').
110+
If you want to execute command for all project modules you can write '-pm=ALL'.
105111

106112
[--offline | --airplane-mode]
107113
to work offline without updating origin/MAIN_BRANCH_NAME
@@ -121,6 +127,9 @@ To use vuh with your project you should first create .vuh file in root folder of
121127
This parameter overrides MAIN_BRANCH_NAME configuration variable from .vuh file.
122128

123129
[-pm=<project_module>] to use specified module of your mono repository project (instead of default).
130+
If you want to execute command for multiple project modules you can
131+
specify them separated with commas (f.e. '-pm=API,WEB').
132+
If you want to execute command for all project modules you can write '-pm=ALL'.
124133

125134
[--check-git-diff] to automatically increase version only if current branch has git difference
126135
with HEAD..origin/MAIN_BRANCH_NAME. And if there is no git difference vuh will not
@@ -149,7 +158,7 @@ To use vuh with your project you should first create .vuh file in root folder of
149158
This parameter can't be used with '--dont-check-git-diff'.
150159

151160
[--config-dir=<path>] Search for .vuh configuration file in another directory.
152-
You dont need to specify it if you are working with git repository.
161+
You don't need to specify it if you are working with git repository.
153162
Suggesting to use this parameter with '--dont-use-git' parameter.
154163

155164
uv, update-version Replace your local version with suggesting version which this branch should use.
@@ -166,6 +175,9 @@ To use vuh with your project you should first create .vuh file in root folder of
166175
This parameter overrides MAIN_BRANCH_NAME configuration variable from .vuh file.
167176

168177
[-pm=<project_module>] to use specified module of your mono repository project (instead of default).
178+
If you want to execute command for multiple project modules you can
179+
specify them separated with commas (f.e. '-pm=API,WEB').
180+
If you want to execute command for all project modules you can write '-pm=ALL'.
169181

170182
[--check-git-diff] to automatically increase version only if current branch has git difference
171183
with HEAD..origin/MAIN_BRANCH_NAME. And if there is no git difference vuh will not
@@ -194,21 +206,24 @@ To use vuh with your project you should first create .vuh file in root folder of
194206
This parameter can't be used with '--dont-check-git-diff'.
195207

196208
[--config-dir=<path>] Search for .vuh configuration file in another directory.
197-
You dont need to specify it if you are working with git repository.
209+
You don't need to specify it if you are working with git repository.
198210
Suggesting to use this parameter with '--dont-use-git' parameter.
199211

200212
mrp, module-root-path Show root path of specified module (for monorepos projects).
201213

202214
[-q | --quiet] to show only root path (or errors messages if there are so).
203215

204216
[-pm=<project_module>] to use specified module of mono repository project (instead of default).
217+
If you want to execute command for multiple project modules you can
218+
specify them separated with commas (f.e. '-pm=API,WEB').
219+
If you want to execute command for all project modules you can write '-pm=ALL'.
205220

206221
[--dont-use-git] don't use any git commands.
207222
In this case you should run vuh in root directory (which contains .vuh)
208223
or specify path to it using '--config-path=<path>' parameter.
209224

210225
[--config-dir=<path>] Search for .vuh configuration file in another directory.
211-
You dont need to specify it if you are working with git repository.
226+
You don't need to specify it if you are working with git repository.
212227
Suggesting to use this parameter with '--dont-use-git' parameter.
213228

214229
pm, project-modules Show all project modules of current mono repository
@@ -221,7 +236,7 @@ To use vuh with your project you should first create .vuh file in root folder of
221236
or specify path to it using '--config-path=<path>' parameter.
222237

223238
[--config-dir=<path>] Search for .vuh configuration file in another directory.
224-
You dont need to specify it if you are working with git repository.
239+
You don't need to specify it if you are working with git repository.
225240
Suggesting to use this parameter with '--dont-use-git' parameter.
226241

227242
This tool suggest relevant version for your current project or even update your local project's version.
@@ -251,7 +266,7 @@ List of all config variables for monorepos:
251266

252267
| Variable | Vuh version supporting | Required always | Description | Example |
253268
|-------------------------------------------------|:----------------------:|:---------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
254-
| PROJECT_MODULES | 2.0.0 | No | List of all modules in your mono repository that will have different versioning mechanisms. <br/>You can leave this variable empty if your repository contains only one project. <br/>For each specified module you should specify configuration for this module down below. | 'BACKEND,FRONTEND' (for mono repository with two modules: BACKEND and FRONTEND) |
269+
| PROJECT_MODULES | 2.0.0 | No | List of all modules in your mono repository that will have different versioning mechanisms. <br/>You can leave this variable empty if your repository contains only one project. <br/>For each specified module you should specify configuration for this module down below. Module name 'ALL' reserved, so you cant use it. | 'BACKEND,FRONTEND' (for mono repository with two modules: BACKEND and FRONTEND) |
255270
| \<MODULE>_MAIN_BRANCH_NAME | 2.0.0 | No | The name of the main project's branch (for specific \<MODULE>). By default this value will be equal to MAIN_BRANCH_NAME variable. | 'main' or 'master' |
256271
| \<MODULE>_VERSION_FILE | 2.0.0 | Yes | File which contains version information (for specific \<MODULE>). | 'package.json' <br/> (for node.js application) |
257272
| \<MODULE>_TEXT_BEFORE_VERSION_CODE | 2.0.0 | Yes | Unique text which will be just before version number including spaces (for specific \<MODULE>). All special symbols ('/', '\\', '^', '$', '*', '(', ')', '{', '}', '[', ']') should be escaped with '\\'. | '"version": "' <br/> (for variable "version" in json files so it can find line "version": "version_number") |

0 commit comments

Comments
 (0)