Skip to content
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

Allowing easy-install plugin with bash script #146

Merged
merged 20 commits into from
Jul 3, 2024

Conversation

propilideno
Copy link
Contributor

@propilideno propilideno commented May 5, 2023

Description

The goal of this pull request is:

Checklist

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes are relevant to the project.

WhoAmI

I am Propi (Lucas de Almeida), i'd contributed with Open Source Projects and with Master's degree articles. I also have advanced skills in bash scripting and my changes are huge relevant for this project.

Feel free to contact me.

Changes made

Reused from FrameWeb-VP-Plugin Fork

  • Verify the default paths to app and plugin and ask to confirm the typed path.
  • Download the ontouml-vp-Repository and clean it after installation of plugin
  • Verify JDK and Maven installation, if uninstalled the script is able to install this requirements in UNIX OS.
  • In Windows, this script can open the Tutorial of Maven and JDK Installation.
  • Can install shell requirements like HomeBrew
  • Can modify pom.xml to App dir and Plugin dir given directories or default path.
  • Easy-to-maintain with a lot of functions with good practices.

You can check more informations about behavior in this pull request

My adaptations for OntoUML

  • Updated the script to support OntoUML automatic installation.
  • The code was refactored improving encapsulation from the get_VP_App_Path and get_VP_Plugin_Path functions.
  • I put the curl with bash script under User Instructions, but you can adapt it like @vitorsouza did in FrameWeb
  • Was commented install_maven because in OntoUML, maven is optional. So, we're installing with Maven Wrapper

Testing

Open Git Bash or Terminal, and type:

bash <(curl -sL https://raw.githubusercontent.com/propilideno/ontouml-vp-plugin/master/install.sh)

Final Thoughts

I refrained from including my name in the README file since I am not a member of the team. However, I would be honored if you would consider crediting me for my contributions.

@propilideno propilideno changed the title Allowing easy-install plugin with shell script Allowing easy-install plugin with bash script May 5, 2023
Copy link
Contributor

@matheuslenke matheuslenke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @propilideno! I was taking a look at your code, and had some problems while installing it with Windows. I mainly use Unix systems, however, I need to make sure the experience is good even on Windows machines.

The problem is when changing the path at functions read_App_Path() and read_Plugin_Path(). When answering with "n", it gives an error and does not allow the user to type a new path. I'm not sure what the reason is, but using another auxiliar variable seemed to fix it on what I tested.

Can you please fix it? If you can't, I will change it and approve your PR

install.sh Outdated Show resolved Hide resolved
install.sh Outdated Show resolved Hide resolved
@propilideno
Copy link
Contributor Author

Hello @matheuslenke,
I appreciate your comments and i will review my code within 15 days.

Best Regards,
Lucas Almeida.

README.md Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed on 89196a9

Copy link
Contributor Author

@propilideno propilideno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@propilideno
Copy link
Contributor Author

@matheuslenke

@propilideno propilideno closed this Jul 3, 2024
@propilideno propilideno reopened this Jul 3, 2024
@matheuslenke
Copy link
Contributor

Tested and everything seems fine to me. Thanks for your contribution, really nice the file picker on Windows. Merging now

@matheuslenke matheuslenke merged commit 981e417 into OntoUML:master Jul 3, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants