[OKAPI-541] Add requirement of git 2 in okapi documentation Created: 23/Feb/18  Updated: 03/Jan/20  Resolved: 02/Mar/18

Status: Closed
Project: Okapi
Components: None
Affects versions: 2.9.2
Fix versions: 2.9.3

Type: Bug Priority: P3
Reporter: Dazhi Jiao Assignee: Julian Ladisch
Resolution: Done Votes: 0
Labels: back-end, sprint33
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to OKAPI-293 Maven build fails when building from ... Closed
relates to OKAPI-545 Do not require git for "mvn install" Closed
Sprint:
Tester Assignee: Adam Dickmeiss

 Description   

We had problems when we tried to build okapi by following the documentation on a centos 7 vagrant box.

Here's the commands we used to install required packages and the error message we got from 'mvn install'

# using Vagrant config.vm.box_version = "1801.02" # 7.4.1708
sudo yum -y  update
sudo yum -y install vim java-1.8.0-openjdk-devel
#mvn install
cd /opt
sudo curl -o /opt/apache-maven-3.5.2-bin.tar.gz  ftp://mirror.reverse.net/pub/apache/maven/maven-3/3.5.2/binaries/apache-maven-3.5.2-bin.tar.gz
sudo tar -zxvf /opt/apache-maven-3.5.2-bin.tar.gz
echo 'export PATH=/opt/apache-maven-3.5.2/bin:$PATH' | sudo tee /etc/profile.d/maven.sh
source /etc/profile.d/maven.sh
sudo git clone --recursive https://github.com/folio-org/okapi.git
sudo chown -R vagrant:vagrant /opt/okapi
cd /opt/okapi
git checkout v2.9.1
mvn install
mvn exec:exec
# git version 1.8.3.1
# 
# FAILED with message
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (git submodule update) on project okapi-common: Command execution failed.: Process exited with an error: 1 (Exit value: 1) -> [Help 1]

By default, the git version installed on the Centos box was 1.8.3. We got the following error message:

We fixed the issue by upgrading git to 2.x and it fixed the issue.

Please update the documentation with the requirement of git 2.



 Comments   
Comment by Julian Ladisch [ 26/Feb/18 ]

Thank you Dazhi Jiao for reporting the problems you had with your centos vagrant box.

git versions before 2.0 have been discontinued at the end of 2014: https://en.wikipedia.org/wiki/Git#Releases
I think that we not need to mention that you should use only those software versions that are still supported.

centos is fine for running server software based on old packages. It is not suitable for development or building of software like FOLIO that uses current packages.

Comment by Dazhi Jiao [ 27/Feb/18 ]

Thanks for the explanation, Julian Ladisch! I think the confusion was that I put it in FOLIO instead of OKAPI. We were simply trying to set up OKAPI and following the documentation here: https://github.com/folio-org/okapi/blob/master/doc/guide.md. There was a requirement for git, together with Java 8 and Maven 3.3.1. Therefore I thought, to be consistent, it's worth mentioning git 2, especially since git 1 would fail the build. I agree that if git 1 is not supported it's not completely necessary to mention the version. But a small change to the documentation could be helpful for people who want to try OKAPI out on any vm they choose.

Comment by Julian Ladisch [ 27/Feb/18 ]

Adam Dickmeiss: Please review and merge: https://github.com/folio-org/okapi/pull/544

Comment by Ann-Marie Breaux (Inactive) [ 01/Mar/18 ]

Should this be In Review, or should this be in some other status? Does not appear to be something that the ICs can test.

Comment by David Crossley [ 02/Mar/18 ]

Merged.

Generated at Thu Feb 08 23:10:43 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.