Merge pull request #295 from shivam71/SubModules

Adding netbeans and netbeans-l10n as submodules

Author: sid-srini

.github/workflows/main.yml

@@ -55,21 +55,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           persist-credentials: false
-          submodules: false
-
-      - name: Checkout NetBeans
-        uses: actions/checkout@v4
-        with:
-          repository: apache/netbeans
-          path: netbeans
-          ref: 23
-
-      - name: Checkout NetBeans l10n
-        uses: actions/checkout@v4
-        with:
-          repository: apache/netbeans-l10n
-          path: netbeans-l10n
-          ref: ece00239dc7a208fba60703c2256ffd818da1646
+          submodules: true
 
       - name: Apply NetBeans patches
         run: ant apply-patches

.gitignore

@@ -1,6 +1,4 @@
 build/
-netbeans/
-netbeans-l10n/
 .DS_STORE
 .idea/
 *.iml

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "netbeans-l10n"]
+	path = netbeans-l10n
+	url = https://github.com/apache/netbeans-l10n.git
+[submodule "netbeans"]
+	path = netbeans
+	url = https://github.com/apache/netbeans.git

BUILD.md

@@ -35,16 +35,7 @@
 ## Fetching and building the code
 
 ```bash
-$ git clone https://github.com/oracle/javavscode.git
-$ cd javavscode/
-$ git clone https://github.com/apache/netbeans.git
-$ cd netbeans/
-$ git checkout 23
-$ cd ..
-$ git clone https://github.com/apache/netbeans-l10n.git
-$ cd netbeans-l10n
-$ git checkout ece00239dc7a208fba60703c2256ffd818da1646 # head commit in master
-$ cd ..
+$ git clone --recurse-submodules https://github.com/oracle/javavscode.git
 # the following target requires git executable to be on PATH:
 $ ant apply-patches
 $ ant build-netbeans
@@ -107,3 +98,24 @@ $ npm_config_https_proxy=http://your.proxy.com:port ant test-vscode-ext
 
 when executing the tests for the first time. That shall overcome the proxy
 and download an instance of `code` to execute the tests with.
+
+## Working with submodules 
+This project uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) . In particular netbeans and netbeans-l10n are submodules pointing to specific commits in their respective repositories .
+### Switching Branches 
+Add the --recurse-submodules  flag to the git checkout command to update the submodules during the checkout.
+```bash
+git checkout --recurse-submodules <branch_name>
+```
+Note:- Merging branches with submodules pointing to different commits can be tricky. Refer the [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for more details on the same.
+### Changing submodules versions 
+```bash
+# Fetching changes from remote submodule repositories 
+git submodule update --remote   
+# Changing the submodule version
+cd netbeans
+git checkout <commit_hash>
+cd ..
+# Committing the submodule version 
+git add netbeans
+git commit -m "Updated netbeans"
+```