0

Should I commit the ENTIRE codebase, as well as the POM(s), and have users check out projects one at a time for multiple maven projects, one of which contains several modules?

Should I ONLY commit the POMs, and configure SCM information within each POM?

How do commits/check outs work when you configure the maven SCM plugin? Do you store the POM's via subversion, check them out, and then materialize the POM so maven will download the rest of the corresponding files to that project? What if you needed to add new files, but you were using SCM through maven?

I'm very confused about the difference between just storing files using svn (the standard way), vs storing the SCM information on a per-pom basis. There appears to be absolutely NOTHING for documentation on how to use Maven and load it with SCM information.

Is it best to store the SCM information directly inside of POMs, or as I said before, should I just add entire projects to SVN including their respective POMs?

Or is it better to embed the SCM information directly into maven, and have maven materialize said project? Does the Maven SCM plugin play nicely with subclipse? For example - after you "materialize" a project from a maven POM, does it import the project files from SVN, and then show them in eclipse as under version control? If I was embedding SCM information into maven POMs, would I then just create a separate SVN repo for ONLY my pom files? Or would I just put all the POM files directly in the trunk of my engineering repo?

Hopefully someone can help me clarify this. I'm very confused. Thanks!

Sam Levin
  • 3,326
  • 7
  • 30
  • 44

1 Answers1

2

Always commit all your source code in the SCM. Otherwise you don't have a history of your source code.

Also commit your pom in SCM, otherwise you don't have a history of how it should be built. Such a history is critical for being able to build old branches of your software, and since the build and the source code is so tightly coupled, it is a good idea to commit the pom.xml in the same repository as your source code.

To facilitate other maven tools, you might want to mention your SCM in the pom.xml. That is optional, but I would highly recommend you do it. This allows CI systems to verify that their copy of the source code is the latest, and gives them the configuration needed to checkout a new copy if necessary.

I am not aware of any tool or plugin that actually checks in code for you. If you don't check in your source code, then all the other tools will check out a simple pom.xml (because that's all that is in the SCM), and the SCM reference won't be able to tell anyone where the source code is (because it is not in the SCM).

Edwin Buck
  • 69,361
  • 7
  • 100
  • 138
  • I think it's called Bootstrapping. But I'm not sure – Sam Levin Feb 02 '12 at 14:43
  • When I store the project in SVN, I don't include the eclipse .project settings and anything else that's auto-generated. Should I be committing the eclipse project too? When you check out my maven project via svn (import > import from svn) and you select "check out as projects in the workspace", it doesn't recognize it as a maven/java project. It just shows the pom and the files but doesn't have any maven support. However, if I check out the project as a Maven project, then it works, but it doesn't show the files as being under SVN control. It's weird. What am I missing? – Sam Levin Feb 02 '12 at 14:48
  • @SamLevin, Generally I don't check in the eclipse .project settings, because any modification to the project (which includes setting arguments to run-time configurations) tends to get erased when doing a svn update, or propagated undesirably when doing a svn commit. However, it is useful to have the files distributed, to facilitate the initial setup (and avoid having manuals detailing what items to set and where). So I make a folder which places the configuration files just outside of their normal location, and put a "setup" script in it, which copies the files to their proper locations. – Edwin Buck Feb 02 '12 at 17:15
  • The maven-release-plugin can check in your pom.xml files and ceate a tag. See this answer to a kind of similar question https://stackoverflow.com/a/8125575/2272572 – newur Jul 17 '18 at 18:18
  • @newur The maven-release-plugin can check in a pom.xml file; but only after checking it out (and it checks it into a branch, in preparation for a release). I think you uber-skimmed the question and answer, this isn't about releasing, this is about checking in developmental changes (and how much to check in). There's no automated tool in Maven that tells you what you should check in, or when to check it in (as you might not be done with your development changes yet, and there are valid source files that are only build intermediates yacc to c files, for example). – Edwin Buck Jul 19 '18 at 11:39
  • @Edwin Fair point, I mixed up the question and answer to an unfitting comment. What you said is correct. – newur Jul 20 '18 at 13:07