MBT upgrade build parameter ignore attribute#1050
Open
young-yang03 wants to merge 41 commits into
Open
Conversation
added 2 commits
May 15, 2023 17:26
modified: internal/archive/mta_location.go new file: micromatch/micromatch-wrapper.js new file: micromatch/package-lock.json new file: micromatch/package.json new file: micromatch/run_test.sh new file: micromatch/test-micromatch.js new file: micromatch/test_micromatch_for_mta.go new file: micromatch/test_micromatch_wrapper_bin.go new file: micromatch/test_micromatch_wrapper_js.go
added 26 commits
May 18, 2023 16:28
modified: internal/archive/fsops.go modified: micromatch/micromatch-wrapper.js modified: micromatch/test_micromatch_wrapper_bin.go modified: micromatch/test_micromatch_wrapper_js.go
modified: micromatch/test_micromatch_wrapper_bin.go modified: micromatch/test_micromatch_wrapper_js.go
modified: internal/archive/fsops.go modified: internal/archive/fsops_test.go modified: internal/artifacts/module_arch.go modified: internal/artifacts/module_arch_test.go modified: internal/artifacts/mtar.go modified: internal/commands/commands.go modified: internal/platform/model.go modified: micromatch/micromatch-wrapper.js modified: micromatch/run_test.sh modified: micromatch/test-micromatch.js deleted: micromatch/test_micromatch_for_mta.go modified: micromatch/test_micromatch_wrapper_js.go
modified: internal/archive/fsops_test.go modified: micromatch/micromatch-wrapper.js modified: micromatch/test-micromatch.js modified: micromatch/test_micromatch_wrapper_js.go
modified: micromatch/test-micromatch.js
modified: internal/archive/fsops_test.go new file: internal/archive/testdata/testignorewithsymlink/another_content/symlink_to_test4.txt new file: internal/archive/testdata/testignorewithsymlink/another_content/test3.txt new file: internal/archive/testdata/testignorewithsymlink/clean-symlink-env.bat new file: internal/archive/testdata/testignorewithsymlink/content/symlink_dir_to_another_content new file: internal/archive/testdata/testignorewithsymlink/content/test.txt new file: internal/archive/testdata/testignorewithsymlink/content/test_dir/test1.txt new file: internal/archive/testdata/testignorewithsymlink/dir_with_recursive_symlink/subdir/symlink_dir_recursion_to_parent_dir new file: internal/archive/testdata/testignorewithsymlink/dir_with_recursive_symlink/subdir/symlink_dir_to_sibling new file: internal/archive/testdata/testignorewithsymlink/dir_with_recursive_symlink/subdir2/symlink_dir_to_sibling new file: internal/archive/testdata/testignorewithsymlink/moduleNew/package.json new file: internal/archive/testdata/testignorewithsymlink/moduleNew/symlink_dir_to_content new file: internal/archive/testdata/testignorewithsymlink/prepare-symlink-env.bat new file: internal/archive/testdata/testignorewithsymlink/symlink_dir_to_moduleNew new file: internal/archive/testdata/testignorewithsymlink/symlink_dir_to_symlink_dir_broken new file: internal/archive/testdata/testignorewithsymlink/symlink_to_symlink_broken new file: internal/archive/testdata/testignorewithsymlink/test4.txt modified: internal/artifacts/module_arch.go modified: internal/artifacts/mtar.go
modified: internal/archive/fsops.go modified: internal/archive/fsops_test.go new file: internal/archive/testdata/testproject/ui5app/webapp/view/.invisibleView
new file: cmd/testdata/mtaignore/mta-ignore-node_modules-subfolders.yaml new file: cmd/testdata/mtaignore/node-js/gulpfile.js new file: cmd/testdata/mtaignore/node-js/package-lock.json new file: cmd/testdata/mtaignore/node-js/package.json new file: cmd/testdata/mtaignore/node-js/server.js
modified: cmd/build_parameter_test.go modified: cmd/cmd_test.go modified: cmd/init.go modified: internal/archive/fsops.go deleted: internal/archive/testdata/testignorewithsymlink/another_content/symlink_to_test4.txt deleted: internal/archive/testdata/testignorewithsymlink/content/symlink_dir_to_another_content deleted: internal/archive/testdata/testignorewithsymlink/dir_with_recursive_symlink/subdir/symlink_dir_recursion_to_parent_dir deleted: internal/archive/testdata/testignorewithsymlink/dir_with_recursive_symlink/subdir/symlink_dir_to_sibling deleted: internal/archive/testdata/testignorewithsymlink/dir_with_recursive_symlink/subdir2/symlink_dir_to_sibling deleted: internal/archive/testdata/testignorewithsymlink/moduleNew/symlink_dir_to_content deleted: internal/archive/testdata/testignorewithsymlink/symlink_dir_to_moduleNew deleted: internal/archive/testdata/testignorewithsymlink/symlink_dir_to_symlink_dir_broken deleted: internal/archive/testdata/testignorewithsymlink/symlink_to_symlink_broken modified: package-lock.json
modified: internal/archive/fsops.go deleted: internal/artifacts/testdata/mtahtml5/.mtahtml5_mta_build_tmp/xs-security.json new file: micromatch/build-install-test.sh new file: micromatch/build-install.sh modified: micromatch/micromatch-wrapper.js new file: micromatch/node-js/gulpfile.js new file: micromatch/node-js/package.json new file: micromatch/node-js/server.js deleted: micromatch/run_test.sh new file: micromatch/test.sh modified: micromatch/test_micromatch_wrapper_js.go
modified: .goreleaser.yml modified: Dockerfile_mbtci_template modified: cmd/init_test.go modified: cmd/testdata/mta/mta.yaml modified: integration/cloud_mta_build_tool_test.go modified: internal/archive/fsops_test.go new file: micromatch/Darwin/micromatch-wrapper new file: micromatch/Linux/micromatch-wrapper new file: micromatch/Windows/micromatch-wrapper.exe modified: micromatch/build-install.sh modified: package.json
modified: index.js
modified: micromatch/Darwin/micromatch-wrapper modified: micromatch/Linux/micromatch-wrapper modified: micromatch/Windows/micromatch-wrapper.exe modified: package-lock.json
modified: cmd/build_parameter_test.go modified: cmd/init_test.go modified: micromatch/Darwin/micromatch-wrapper modified: micromatch/Linux/micromatch-wrapper modified: micromatch/Windows/micromatch-wrapper.exe
modified: cmd/init_test.go
modified: cmd/build_parameter_test.go
modified: cmd/init_test.go
modified: Dockerfile_mbtci_template modified: cmd/init_test.go
modified: Makefile modified: test/goss/goss_template.yaml
modified: configs/builder_type_cfg.yaml
ShiraManas
reviewed
Jul 5, 2023
|
|
||
| - [Download](https://github.com/SAP/cloud-mta-build-tool/releases) the latest source code. | ||
|
|
||
| - Install [pkg](https://github.com/vercel/pkg/) on your operating system |
There was a problem hiding this comment.
Install pkg on your operating system:
ShiraManas
reviewed
Jul 5, 2023
| npm install -g pkg | ||
| ``` | ||
|
|
||
| - Build micromatch wrapper under `micromatch` subfolder of source code |
There was a problem hiding this comment.
Build the micromatch wrapper under the micromatch subfolder of the source code:
ShiraManas
reviewed
Jul 5, 2023
| ``` | ||
| - Add the binary file to your `~/bin` path according to your operating system: | ||
|
|
||
| * In Darwin, copy binary file `micromatch-wrapper` to the `~/usr/local/bin/` folder, for example: `cp micromatch-wrapper-macos /usr/local/bin/micromatch-wrapper` |
There was a problem hiding this comment.
In Darwin, copy the micromatch-wrapper binary file to the ~/usr/local/bin/ folder.
Here is a sample command: cp micromatch-wrapper-macos /usr/local/bin/micromatch-wrapper
ShiraManas
reviewed
Jul 5, 2023
|
|
||
| * In Darwin, copy binary file `micromatch-wrapper` to the `~/usr/local/bin/` folder, for example: `cp micromatch-wrapper-macos /usr/local/bin/micromatch-wrapper` | ||
|
|
||
| * In Linux, copy binary file `micromatch-wrapper` to the `~/usr/local/bin/` folder, for example: `cp micromatch-wrapper-linux /usr/local/bin/micromatch-wrapper` |
There was a problem hiding this comment.
In Linux, copy the micromatch-wrapper binary file to the ~/usr/local/bin/ folder.
Here is a sample command: cp micromatch-wrapper-linux /usr/local/bin/micromatch-wrapper
ShiraManas
reviewed
Jul 5, 2023
|
|
||
| **Install using npm** | ||
|
|
||
| Run the command below, it will install mbt and micromatch-wrapper together |
There was a problem hiding this comment.
Run the command below to install MBT and the micromatch wrapper together:
ShiraManas
reviewed
Jul 5, 2023
| The same approach can be implemented if the `maven` builder is used in the global build step. | ||
|
|
||
| ## v1.2.25 | ||
| The build-parameters ignore attribute will be upgraded to support [Full Glob Pattern](https://en.wikipedia.org/wiki/Glob_(programming)). |
There was a problem hiding this comment.
The 'build-parameters ignore' attribute will be upgraded to support glob patterns.
ShiraManas
reviewed
Jul 5, 2023
| ## v1.2.25 | ||
| The build-parameters ignore attribute will be upgraded to support [Full Glob Pattern](https://en.wikipedia.org/wiki/Glob_(programming)). | ||
|
|
||
| Wildcards, such as `*`,`!`,`?` can be used to match characters. You can package specified content by using negation pattern `!` |
There was a problem hiding this comment.
Wildcards, such as *,!,? can be used to match characters. You can package specific content by using the ! negation pattern.
(Is there a mistake? How can it be that ! is used to match and to negate?
Also, can we say "select specific content" in the second sentence above instead of "package specified content"? Is this correct?)
Contributor
Author
There was a problem hiding this comment.
By using negation pattern ! in the build-parameters ignore attribute, because not ignore equal to include, you can select specified content into the package.
ShiraManas
reviewed
Jul 5, 2023
| build-result: myfolder | ||
| ignore: ["node_modules/**", "!node_modules/mtainclude"] | ||
|
|
||
| # In this example, all files and subfolders of node_modules will not be packaged in to MTA archive |
There was a problem hiding this comment.
In this example, all files and subfolders of 'node_modules' will not be packaged into the MTA archive, except for the 'mtainclude' subfolder of 'node_modules'.
ShiraManas
reviewed
Jul 5, 2023
ShiraManas
left a comment
ShiraManas
left a comment
There was a problem hiding this comment.
Hi. I've added some suggestions here.
added 2 commits
July 5, 2023 21:42
modified: internal/artifacts/module_arch.go modified: internal/artifacts/mtar.go
modified: docs/docs/download.md modified: docs/docs/micromatch-wrapper.md modified: docs/docs/whatsnew.md
Contributor
Author
|
@ShiraManas I recommit the documents, pls review it, thanks |
ShiraManas
reviewed
Jul 10, 2023
| # all files with the"txt" extension and the "mtaignore" folder within the "myfolder" directory. | ||
|
|
||
| ``` | ||
| From MBT 1.2.25 version, the `build-parameters ignore` attribute will be upgraded to support [full glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)). Wildcards, such as `*`,`!`,`?` can be used to match characters. |
There was a problem hiding this comment.
-From the MBT 1.2.25 version,
-"full glob patterns" instead of "full glob pattern"
ShiraManas
reviewed
Jul 10, 2023
|
|
||
| From MBT 1.2.25 version, the `build-parameters ignore` attribute will be upgraded to support [full glob patterns](https://en.wikipedia.org/wiki/Glob_(programming)). You must install the micromatch wrapper to use the glob patterns. | ||
|
|
||
| You can install micromatch-wrapp by instruction [Here](https://github.com/SAP/cloud-mta-build-tool/tree/master/docs/docs/micromatch-wrapper.md) No newline at end of file |
There was a problem hiding this comment.
Follow the instructions to install the micromatch wrapper.
ShiraManas
reviewed
Jul 10, 2023
| @@ -0,0 +1,52 @@ | |||
| #### Overview | |||
| [Micromatch](https://github.com/micromatch/micromatch) support various matching features, such as glob patterns and advanced globbing | |||
There was a problem hiding this comment.
Just add the missing period at the end of the sentence:
Micromatch support various matching features, such as glob patterns and advanced globbing.
ShiraManas
reviewed
Jul 10, 2023
| #### Overview | ||
| [Micromatch](https://github.com/micromatch/micromatch) support various matching features, such as glob patterns and advanced globbing | ||
|
|
||
| Micromatch is a Node.js application, while MBT is a Go application. The micromatch wrapper is a package that enables MBT to use the functionalities provided by micromatch. From MBT 1.2.25 version, we create [micromath wrapper](https://github.com/SAP/cloud-mta-build-tool/tree/master/micromatch) to package it. |
There was a problem hiding this comment.
From the MBT 1.2.25 version, we provide the micromatch wrapper to package it.
ShiraManas
reviewed
Jul 10, 2023
| ``` | ||
| From MBT 1.2.25 version, the `build-parameters ignore` attribute will be upgraded to support [full glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)). Wildcards, such as `*`,`!`,`?` can be used to match characters. | ||
|
|
||
| By using negation pattern `!` in the `build-parameters ignore` attribute, because `not ignore` equal to `include`, it means you can select specified content into the package. |
There was a problem hiding this comment.
By using the ! negation pattern in the build-parameters ignore attribute, you can select specified content into the package (because not ignore equals include).
ShiraManas
reviewed
Jul 10, 2023
| npm install -g mbt | ||
| ``` | ||
|
|
||
| From MBT 1.2.25 version, the `build-parameters ignore` attribute will be upgraded to support [full glob patterns](https://en.wikipedia.org/wiki/Glob_(programming)). You must install the micromatch wrapper to use the glob patterns. |
ShiraManas
reviewed
Jul 10, 2023
| The same approach can be implemented if the `maven` builder is used in the global build step. | ||
|
|
||
| ## v1.2.25 | ||
| The `build-parameters ignore` attribute will be upgraded to support [full glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)). Wildcards, such as `*`,`!`,`?` can be used to match characters. |
There was a problem hiding this comment.
The build-parameters ignore attribute will be upgraded to support full glob patterns.
ShiraManas
reviewed
Jul 10, 2023
| ## v1.2.25 | ||
| The `build-parameters ignore` attribute will be upgraded to support [full glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)). Wildcards, such as `*`,`!`,`?` can be used to match characters. | ||
|
|
||
| By using negation pattern `!` in the `build-parameters ignore` attribute, because `not ignore` equal to `include`, it means you can select specified content into the package. |
There was a problem hiding this comment.
By using the ! negation pattern in the build-parameters ignore attribute, you can select specified content into the package (because not ignore equal to include).
Contributor
Author
There was a problem hiding this comment.
OK, my recommit just a little different with your suggestion.
To be consistent with the front， equal to -> equals
ShiraManas
reviewed
Jul 10, 2023
ShiraManas
left a comment
ShiraManas
left a comment
There was a problem hiding this comment.
Looks much better! Added my last few comments here.
added 5 commits
July 13, 2023 10:42
modified: cmd/testdata/mta/mta.yaml new file: cmd/testdata/mtaignore/mta-ignore-all-invisible-dir-and-files.yaml modified: cmd/testdata/mtaignore/mta-ignore-all-node_modules.yaml modified: cmd/testdata/mtaignore/mta-ignore-node_modules-subfolders.yaml new file: cmd/testdata/mtaignore/node-js/.invisible-file new file: cmd/testdata/mtaignore/node-js/.invisibledir-1/.invisible-file-1 new file: cmd/testdata/mtaignore/node-js/.invisibledir-2/visible-file-2 modified: internal/artifacts/module_arch.go modified: internal/artifacts/mtar.go modified: micromatch/test-micromatch.js
…les.yaml modified: cmd/testdata/mtaignore/mta-ignore-all-node_modules.yaml modified: cmd/testdata/mtaignore/mta-ignore-node_modules-subfolders.yaml renamed: cmd/testdata/mtaignore/node-js/.invisibledir-1/.invisible-file-1 -> cmd/testdata/mtaignore/node-js/.invisible-dir/.invisible-file renamed: cmd/testdata/mtaignore/node-js/.invisibledir-2/visible-file-2 -> cmd/testdata/mtaignore/node-js/.invisible-dir/.invisible-sub-dir/.invisible-sub-file new file: cmd/testdata/mtaignore/node-js/.invisible-dir/.invisible-sub-dir/visible-sub-file new file: cmd/testdata/mtaignore/node-js/.invisible-dir/visible-file new file: cmd/testdata/mtaignore/node-js/.invisible-dir/visible-sub-dir/.invisible-sub-file new file: cmd/testdata/mtaignore/node-js/.invisible-dir/visible-sub-dir/visible-sub-file modified: internal/artifacts/module_arch.go modified: internal/artifacts/mtar.go
modified: docs/docs/download.md modified: docs/docs/micromatch-wrapper.md modified: docs/docs/whatsnew.md
modified: docs/docs/download.md modified: docs/docs/whatsnew.md
Contributor
Author
|
@ShiraManas, these days I added a new bool type attribute |
ShiraManas
reviewed
Jul 17, 2023
|
|
||
| By using the negation pattern `!` in the `build-parameters ignore` attribute, you can select specified content into the package (because `not ignore` equals `include`). | ||
|
|
||
| Notice, to avoid regression, a new bool type attribute `build-parameters ignore-use-full-glob-pattern` (default value is `false`) is added. Only when it is true, `build-parameters ignore` will support [full glob patterns](https://en.wikipedia.org/wiki/Glob_(programming)), otherwise MBT package behavior and result remain unchanged. |
There was a problem hiding this comment.
To avoid regression, a new bool type attribute, build-parameters ignore-use-full-glob-pattern (the default value is false), has been added. Only when it is set to true, build-parameters ignore will support full glob patterns. Otherwise the MBT package behavior and result remain unchanged.
ShiraManas
reviewed
Jul 17, 2023
|
|
||
| By using the `!` negation pattern in the `build-parameters ignore` attribute, you can select specified content into the package (because `not ignore` equals `include`). | ||
|
|
||
| Notice, to avoid regression, a new bool type attribute `build-parameters ignore-use-full-glob-pattern` (default value is `false`) is added. Only when it is true, `build-parameters ignore` will support [full glob patterns](https://en.wikipedia.org/wiki/Glob_(programming)), otherwise MBT package behavior and result remain unchanged. |
There was a problem hiding this comment.
To avoid regression, a new bool type attribute, build-parameters ignore-use-full-glob-pattern (the default value is false), has been added. Only when it is set to true, build-parameters ignore will support full glob patterns. Otherwise the MBT package behavior and result remain unchanged.
modified: docs/docs/whatsnew.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
MBT upgrade build parameter ignore attribute to support full Glob Pattern
https://wiki.one.int.sap/wiki/pages/viewpage.action?spaceKey=LCNCBJ&title=MBT+Support+Package+Specified+Content+into+MTA+archive
Checklist