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

LogMojo : Rename variables in order to align with documentation #868

Closed
2 tasks done
rohanKanojia opened this issue Aug 31, 2021 · 7 comments · Fixed by #874
Closed
2 tasks done

LogMojo : Rename variables in order to align with documentation #868

rohanKanojia opened this issue Aug 31, 2021 · 7 comments · Fixed by #874
Assignees
Labels
first-timers-only Is this your first time contributing? This could be a good place to start! good first issue Good for newcomers

Comments

@rohanKanojia
Copy link
Member

rohanKanojia commented Aug 31, 2021

Right now there is a mismatch between variable names in Mojos and in the plugin documentation. Although it's harmless since variables are private and can't be directly used in XML configuration.

But for avoiding confusion, it's better to rename them.
https://github.com/eclipse/jkube/blob/2bd55bcc7c830e50929b6ede5d0da242e42dda30/kubernetes-maven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/develop/LogMojo.java#L37-L41

  • Rename followLog -> logFollow
  • Rename podName -> logPodName
@rohanKanojia rohanKanojia added good first issue Good for newcomers first-timers-only Is this your first time contributing? This could be a good place to start! labels Aug 31, 2021
@rohanKanojia rohanKanojia changed the title LogMojo : Rename variables in to align with documentation LogMojo : Rename variables in order to align with documentation Aug 31, 2021
@izzy-el
Copy link
Contributor

izzy-el commented Aug 31, 2021

Can I pick this up?

@izzy-el
Copy link
Contributor

izzy-el commented Aug 31, 2021

Thank you! This is my first open source contribution. Where can I see the rules for contributing to this repository?
And, just to be sure, I need to fork this repository and create a new branch, right?

@rohanKanojia
Copy link
Member Author

Yes, you're right. You'd need to fork the repository, create a new branch and push it to your fork. After pushing it, you would need to create a PR from Github UI. Maybe this guide can help clear your doubts better: https://www.dataschool.io/how-to-contribute-on-github/.

In order to contribute to Eclipse, you would need to create an Eclipse Account and Sign Eclipse Contributor Agreement. Once you've created an eclipse account you would need to update your commit message with a Signed-off-by: footer. You can do it like this:

# (Optional): Configure Git User and Email
git config user.name "Your Name"
git config user.email "your_email@example.com"

# Amend your previous commit with signed off footer
git commit --amend --signoff

@izzy-el
Copy link
Contributor

izzy-el commented Aug 31, 2021

I appreciate it. Right now, I just finished my commit on my fork on a new branch that I have created. I am opening a PR right now and I was going through the checklist. Two of the items is to test my changes on the code in either Kubernetes or OpenShift. How can I test my code on them? I mean, even though I just changed the variables name, I feel like this is something I should do.

@tejassinghsital
Copy link

Hi I am a beginner and want to contribute to open source. I am looking for some simple issues that I can resolve. Please respond back.

@manusa
Copy link
Member

manusa commented Sep 1, 2021

Hi @tejassinghsital ,

Hi I am a beginner and want to contribute to open source. I am looking for some simple issues that I can resolve. Please respond back.

https://github.com/eclipse/jkube/issues?q=is%3Aissue+is%3Aopen+label%3Afirst-timers-only

They are all taken right now. We'll be adding a few more later today.

@rohanKanojia
Copy link
Member Author

@izzy-el: cool, In order to do this you would need to get access to a Kubernetes cluster. If you want to install it locally, you can use minikube or kind. For OpenShift, you can get a free instance at Red Hat Developer Sandbox: https://developers.redhat.com/developer-sandbox

Once you have access to a Kubernetes Cluster; You need to build a SNAPSHOT version of jkube. You can do this by running this command (mvn clean install or mvn clean install -DskipTests(faster)) in jkube project directory.

You can go to some quickstart in quickstarts/maven folder, modify jkube.version property and then run:

# Run eval $(minikube -p minikube docker-env) first to expose minikube docker daemon to local session
mvn package k8s:build k8s:resource k8s:apply`

In case of OpenShift it should be:

mvn package oc:build oc:resource oc:apply

This should deploy the application.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
first-timers-only Is this your first time contributing? This could be a good place to start! good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants