Repository navigation
Nesting Projects by their Cluster #9624
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jtulach
wants to merge
1
commit into
apache:master
Choose a base branch
from
jtulach:jtulach/NestingProjectsByCluster
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
|
|
||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
|
|
||
| --> | ||
| <project name="IDE Cluster" basedir="../nbbuild" default="build-nozip"> | ||
| <description>IDE Cluster build script</description> | ||
| </project> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,272 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://www.netbeans.org/ns/project/1"> | ||
| <type>org.netbeans.modules.ant.freeform</type> | ||
| <configuration> | ||
| <general-data xmlns="http://www.netbeans.org/ns/freeform-project/1"> | ||
| <name>IDE Cluster</name> | ||
| <properties/> | ||
| <ide-actions/> | ||
| <subprojects> | ||
| <project>api.debugger</project> | ||
| <project>api.java.classpath</project> | ||
| <project>api.lsp</project> | ||
| <project>api.xml</project> | ||
| <project>api.xml.ui</project> | ||
| <project>bcpg</project> | ||
| <project>bcpkix</project> | ||
| <project>bcprov</project> | ||
| <project>bcutil</project> | ||
| <project>bugtracking</project> | ||
| <project>bugtracking.bridge</project> | ||
| <project>bugtracking.commons</project> | ||
| <project>c.googlecode.javaewah.JavaEWAH</project> | ||
| <project>c.google.gson</project> | ||
| <project>c.google.guava</project> | ||
| <project>c.google.guava.failureaccess</project> | ||
| <project>c.jcraft.jsch</project> | ||
| <project>c.jcraft.jzlib</project> | ||
| <project>code.analysis</project> | ||
| <project>core.browser</project> | ||
| <project>core.browser.webview</project> | ||
| <project>core.ide</project> | ||
| <project>core.multitabs.project</project> | ||
| <project>csl.api</project> | ||
| <project>csl.types</project> | ||
| <project>css.editor</project> | ||
| <project>css.lib</project> | ||
| <project>css.model</project> | ||
| <project>css.prep</project> | ||
| <project>css.visual</project> | ||
| <project>db</project> | ||
| <project>dbapi</project> | ||
| <project>db.core</project> | ||
| <project>db.dataview</project> | ||
| <project>db.drivers</project> | ||
| <project>db.kit</project> | ||
| <project>db.metadata.model</project> | ||
| <project>db.mysql</project> | ||
| <project>db.sql.editor</project> | ||
| <project>db.sql.visualeditor</project> | ||
| <project>defaults</project> | ||
| <project>derby</project> | ||
| <project>diff</project> | ||
| <project>dlight.nativeexecution</project> | ||
| <project>dlight.nativeexecution.nb</project> | ||
| <project>dlight.terminal</project> | ||
| <project>docker.api</project> | ||
| <project>docker.editor</project> | ||
| <project>docker.ui</project> | ||
| <project>editor</project> | ||
| <project>editor.actions</project> | ||
| <project>editor.autosave</project> | ||
| <project>editor.bookmarks</project> | ||
| <project>editor.bracesmatching</project> | ||
| <project>editor.breadcrumbs</project> | ||
| <project>editor.codetemplates</project> | ||
| <project>editor.completion</project> | ||
| <project>editor.deprecated.pre65formatting</project> | ||
| <project>editor.document</project> | ||
| <project>editor.errorstripe</project> | ||
| <project>editor.errorstripe.api</project> | ||
| <project>editor.fold</project> | ||
| <project>editor.fold.nbui</project> | ||
| <project>editor.global.format</project> | ||
| <project>editor.guards</project> | ||
| <project>editor.indent</project> | ||
| <project>editor.indent.project</project> | ||
| <project>editor.indent.support</project> | ||
| <project>editor.kit</project> | ||
| <project>editor.lib</project> | ||
| <project>editor.lib2</project> | ||
| <project>editor.macros</project> | ||
| <project>editor.plain</project> | ||
| <project>editor.plain.lib</project> | ||
| <project>editor.search</project> | ||
| <project>editor.settings</project> | ||
| <project>editor.settings.lib</project> | ||
| <project>editor.settings.storage</project> | ||
| <project>editor.structure</project> | ||
| <project>editor.tools.storage</project> | ||
| <project>editor.util</project> | ||
| <project>extbrowser</project> | ||
| <project>extexecution</project> | ||
| <project>extexecution.base</project> | ||
| <project>extexecution.impl</project> | ||
| <project>extexecution.process</project> | ||
| <project>git</project> | ||
| <project>go.lang</project> | ||
| <project>gototest</project> | ||
| <project>gsf.codecoverage</project> | ||
| <project>gsf.testrunner</project> | ||
| <project>gsf.testrunner.ui</project> | ||
| <project>html</project> | ||
| <project>html.custom</project> | ||
| <project>html.editor</project> | ||
| <project>html.editor.lib</project> | ||
| <project>html.indexing</project> | ||
| <project>html.lexer</project> | ||
| <project>html.parser</project> | ||
| <project>html.validation</project> | ||
| <project>httpserver</project> | ||
| <project>hudson</project> | ||
| <project>hudson.git</project> | ||
| <project>hudson.mercurial</project> | ||
| <project>hudson.subversion</project> | ||
| <project>hudson.tasklist</project> | ||
| <project>hudson.ui</project> | ||
| <project>ide.kit</project> | ||
| <project>image</project> | ||
| <project>javascript2.debug</project> | ||
| <project>javascript2.debug.ui</project> | ||
| <project>jellytools.ide</project> | ||
| <project>jumpto</project> | ||
| <project>languages</project> | ||
| <project>languages.diff</project> | ||
| <project>languages.env</project> | ||
| <project>languages.go</project> | ||
| <project>languages.hcl</project> | ||
| <project>languages.jflex</project> | ||
| <project>languages.manifest</project> | ||
| <project>languages.toml</project> | ||
| <project>languages.yaml</project> | ||
| <project>lexer</project> | ||
| <project>lexer.antlr4</project> | ||
| <project>lexer.nbbridge</project> | ||
| <project>libs.antlr3.runtime</project> | ||
| <project>libs.antlr4.runtime</project> | ||
| <project>libs.c.kohlschutter.junixsocket</project> | ||
| <project>libs.commons_compress</project> | ||
| <project>libs.commons_net</project> | ||
| <project>libs.flexmark</project> | ||
| <project>libs.freemarker</project> | ||
| <project>libs.git</project> | ||
| <project>libs.graalsdk</project> | ||
| <project>libs.graalsdk.system</project> | ||
| <project>libs.ini4j</project> | ||
| <project>libs.jaxb</project> | ||
| <project>libs.jcodings</project> | ||
| <project>libs.jsch.agentproxy</project> | ||
| <project>libs.json_simple</project> | ||
| <project>libs.lucene</project> | ||
| <project>libs.snakeyaml_engine</project> | ||
| <project>libs.svnClientAdapter</project> | ||
| <project>libs.svnClientAdapter.javahl</project> | ||
| <project>libs.tomlj</project> | ||
| <project>libs.tomljava</project> | ||
| <project>libs.truffleapi</project> | ||
| <project>libs.xerces</project> | ||
| <project>lib.terminalemulator</project> | ||
| <project>localhistory</project> | ||
| <project>lsp.client</project> | ||
| <project>markdown</project> | ||
| <project>mercurial</project> | ||
| <project>nativeimage.api</project> | ||
| <project>notifications</project> | ||
| <project>o.apache.sshd.osgi</project> | ||
| <project>o.apache.sshd.sftp</project> | ||
| <project>o.apache.xml.resolver</project> | ||
| <project>o.eclipse.jgit</project> | ||
| <project>o.eclipse.jgit.gpg.bc</project> | ||
| <project>o.eclipse.jgit.lfs</project> | ||
| <project>o.eclipse.jgit.ssh.apache</project> | ||
| <project>o.eclipse.jgit.ssh.apache.agent</project> | ||
| <project>o.n.agent</project> | ||
| <project>o.n.swing.dirchooser</project> | ||
| <project>o.openidex.util</project> | ||
| <project>options.editor</project> | ||
| <project>parsing.api</project> | ||
| <project>parsing.indexing</project> | ||
| <project>parsing.lucene</project> | ||
| <project>parsing.nb</project> | ||
| <project>parsing.ui</project> | ||
| <project>print.editor</project> | ||
| <project>project.ant</project> | ||
| <project>project.ant.compat8</project> | ||
| <project>project.ant.ui</project> | ||
| <project>projectapi</project> | ||
| <project>projectapi.nb</project> | ||
| <project>project.dependency</project> | ||
| <project>project.indexingbridge</project> | ||
| <project>project.libraries</project> | ||
| <project>project.libraries.ui</project> | ||
| <project>project.spi.intern</project> | ||
| <project>project.spi.intern.impl</project> | ||
| <project>projectui</project> | ||
| <project>projectuiapi</project> | ||
| <project>projectuiapi.base</project> | ||
| <project>projectui.buildmenu</project> | ||
| <project>properties</project> | ||
| <project>properties.syntax</project> | ||
| <project>refactoring.api</project> | ||
| <project>selenium2</project> | ||
| <project>selenium2.server</project> | ||
| <project>server</project> | ||
| <project>servletapi</project> | ||
| <project>schema2beans</project> | ||
| <project>slf4j.api</project> | ||
| <project>slf4j.jdk14</project> | ||
| <project>spellchecker</project> | ||
| <project>spellchecker.apimodule</project> | ||
| <project>spellchecker.bindings.htmlxml</project> | ||
| <project>spellchecker.bindings.properties</project> | ||
| <project>spellchecker.dictionary_en</project> | ||
| <project>spellchecker.kit</project> | ||
| <project>spi.debugger.ui</project> | ||
| <project>spi.editor.hints</project> | ||
| <project>spi.editor.hints.projects</project> | ||
| <project>spi.navigator</project> | ||
| <project>spi.palette</project> | ||
| <project>spi.tasklist</project> | ||
| <project>spi.viewmodel</project> | ||
| <project>subversion</project> | ||
| <project>svg</project> | ||
| <project>swing.validation</project> | ||
| <project>target.iterator</project> | ||
| <project>tasklist.kit</project> | ||
| <project>tasklist.projectint</project> | ||
| <project>tasklist.todo</project> | ||
| <project>tasklist.ui</project> | ||
| <project>team.commons</project> | ||
| <project>team.ide</project> | ||
| <project>terminal</project> | ||
| <project>terminal.nb</project> | ||
| <project>textmate.lexer</project> | ||
| <project>texttools</project> | ||
| <project>usersguide</project> | ||
| <project>utilities</project> | ||
| <project>utilities.project</project> | ||
| <project>versioning</project> | ||
| <project>versioning.core</project> | ||
| <project>versioning.indexingbridge</project> | ||
| <project>versioning.masterfs</project> | ||
| <project>versioning.system.cvss.installer</project> | ||
| <project>versioning.ui</project> | ||
| <project>versioning.util</project> | ||
| <project>web.browser.api</project> | ||
| <project>web.common</project> | ||
| <project>web.common.ui</project> | ||
| <project>web.indent</project> | ||
| <project>web.webkit.debugging</project> | ||
| <project>xml</project> | ||
| <project>xml.axi</project> | ||
| <project>xml.catalog</project> | ||
| <project>xml.catalog.ui</project> | ||
| <project>xml.core</project> | ||
| <project>xml.jaxb.api</project> | ||
| <project>xml.lexer</project> | ||
| <project>xml.multiview</project> | ||
| <project>xml.retriever</project> | ||
| <project>xml.schema.completion</project> | ||
| <project>xml.schema.model</project> | ||
| <project>xml.tax</project> | ||
| <project>xml.text</project> | ||
| <project>xml.text.obsolete90</project> | ||
| <project>xml.tools</project> | ||
| <project>xml.wsdl.model</project> | ||
| <project>xml.xam</project> | ||
| <project>xml.xdm</project> | ||
| <project>xsl</project> | ||
| </subprojects> | ||
| </general-data> | ||
| </configuration> | ||
| </project> | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This list of subprojects has been generated by following shell command:
Using such a script requires manual and tedious work. Ideally the final solution would not rely on shell script at all.
Alternative A: Ant Task
nbbuild/antsrcsources to generate all the "cluster project"Alternative B: New project type in
apisupportapisupportproject would provide new project typeAlternative C: Use Maven
Opinions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would use
nbbuild/cluster.propertiesnot the disk structure. It might highlight inconsistencies. Freeform projects might not be a bad thing as could be useful for other things in future.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a variant of A) could commit the project files but add a tripwire test checking if they still make sense?
Using the build to generate them would break your project group if opened before NB was built.
We have several tripwire tests already which trigger when someone forgets to update something while working on unrelated tasks. (e.g the most recent one checking if an editor hint knows about all javac error keys)
build system job is always enabled, might be a good place for it (
netbeans/.github/workflows/main.yml
Line 385 in 1336aa1
since this isn't used by the build at all (project node doesn't even have a build action - which is OK i think) and purely for dev-time convenience I think it is ok/better to add everything which is currently in the folder. Who knows what cluster config the dev is working on atm + you don't have to open everything anyway.
(comment in the file would also help mentioning that this isn't used by the build, only for dev-time convenience)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?? Not sure why that's relevant? The cluster file includes
nb.cluster.ide.dirandnb.cluster.idewhich already tells you the root folder of this cluster and all the projects that should be listed below. Ideally there is a single source of truth for this stuff.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the cluster subdivision already maps the folder structure -> awesome. I wasn't sure if everything what has a project is actually in the cluster config. The unit test could simply load the property file and compare it against the project.xmls. But tbh the folder is the source of truth, cluster config is "just" release config and probably doesn't have to show everything what is in the repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, this case is exactly the same - take any clusters that share a dir and merge the projects. If it didn't work like that the build wouldn't work correctly.
@jtulach of course, the other way around would be to generate the cluster config from the new folder project files. Any way that doesn't involve keeping everything in sync manually! 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel we are talking about two different things. This nesting here is to visually group projects. The grouping however is by path. The proposed nesting projects are just a trick to have something open which is parent node to NB modules. You could argue that they are redundant if #9631 makes it in - since it would simulate the same behavior if you open the "cluster dir".
This has nothing to do with the build. The nesting projects are not used for the build. NB project list will nest the project if: it is in the same dir && a parent node is open on a parent path (may or may not be a "nesting project").
That is why I said whatever this ends up being it should be documented in a comment what the project files are used for.
I would probably recommend to not merge it and explore #9631 first - maybe this is going to be good enough.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fully aware of those things - the correlations between build clusters and paths on disk exists for a reason.
I disagree that #9631 replaces this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets make sure to document the subtle differences between this PR and #9631 which looks like:
(I suppose the icon would be different)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mbien given my current lack of access to a time machine, the point stood at the time it was made! 😜
Even now I'm not sure if it offers cross-cluster view options or the potential to be updated to validate the build configuration. Still, this is the problem with discussing across multiple things in flux.