-
Notifications
You must be signed in to change notification settings - Fork 305
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update payara-blue with changes from master
- Loading branch information
Showing
3,075 changed files
with
327,323 additions
and
24,826 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains 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,2 @@ | ||
.gitattributes export-ignore | ||
.gitignore export-ignore |
This file contains 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,164 @@ | ||
# Contributing to Payara | ||
|
||
As with many open source projects Payara is hosted on Github, allowing anyone to contribute code and help with its development. To make sure that development is coordinated and that changes are easily tracked, we have a series of steps that should be followed in order to get your code merged. | ||
|
||
## Legal Bits | ||
Payara is an open source project, with the code owned by Payara Foundation a United Kingdom based not for profit company limited by guarantee. As Payara Foundation are the custodians of the code, we have specific legal requirements concerning how we distribute code contributed to the project. Before any code contributed by our community is pulled into our repository we must have a signed Contributor License Agreement from any contributor. This can be downloaded from the main repository at [https://github.com/payara/Payara/blob/master/PayaraCLA.pdf](https://github.com/payara/Payara/blob/master/PayaraCLA.pdf) and should be signed, scanned, and forwarded to [[email protected]](mailto:[email protected]). As compensation for wading through the legalese, all contributors who send in a signed Contributor License Agreement receive a Payara goodie bag. | ||
|
||
As we must also comply with the upstream Oracle Common Development and Distribution license the following line should be added to any changed file: | ||
|
||
``` | ||
Portions Copyright [2017] Payara Foundation and/or its affiliates | ||
``` | ||
|
||
## Getting Payara | ||
You will need to create a personal Github account and fork the repository. | ||
Once you have your own up-to-date version of payara, you can now download it to your computer. | ||
|
||
Install git on your local environment and use the below command to download your remote copy of payara: | ||
|
||
``` | ||
git clone https://github.com/<YourUsername>/Payara | ||
``` | ||
|
||
Git works using "repositories" - stores of data. By default, you have your remote repository on Github, as well as your local repository on your computer. To ensure that future versions of payara incorporate everyones changes, in addition to the current branch there is an upstream branch, where merged changes can be stationed before being added to the project. Adding your own remote repository as the default ("origin") and the upstream payara repository will ensure that you are always able to synchronise yourself with the project as it goes forward. Run the following two commands: | ||
|
||
``` | ||
git remote add upstream https://github.com/payara/Payara | ||
``` | ||
|
||
``` | ||
git remote add origin https://github.com/<YourUsername>/Payara | ||
``` | ||
|
||
You are now free to start working on Payara issues, adding new features, or tinkering with the codebase. | ||
|
||
## Building Payara | ||
Payara uses maven to build the server, you can use either JDK 7 or JDK 8 to build Payara Server, we distribute Payara built with JDK 8. | ||
To build Payara from the root of the cloned source code tree execute; | ||
``` | ||
mvn -DskipTests clean package | ||
``` | ||
When finished the Payara distribution zip file will be available in the directory; | ||
``` | ||
appserver/distributions/payara/target/payara.zip | ||
``` | ||
Payara Micro will be available in the path | ||
``` | ||
appserver/extras/payara-micro/payara-micro-distribution/target/payara-micro.jar | ||
``` | ||
|
||
## Updating your fork | ||
As Payara is under continuous development, our upstream branch is regularly updated with dev and community commits. It is worth synchronising your repository with the upstream repo you added previously. | ||
|
||
To get the latest updates from upstream and merge them into your local repo, enter the following command: | ||
|
||
``` | ||
git fetch upstream | ||
``` | ||
|
||
Then ensure that you are on your local master branch (as opposed to any issue branches you may have): | ||
|
||
``` | ||
git checkout master | ||
``` | ||
|
||
Finally, pull in the changes from upstream to your master and update your remote repository: | ||
|
||
``` | ||
git pull upstream master | ||
``` | ||
|
||
``` | ||
git push origin master | ||
``` | ||
|
||
## Working on an issue | ||
To start working on an issue, create a new branch on your github repo with the following command: | ||
|
||
``` | ||
git checkout -b <BranchName> | ||
``` | ||
|
||
*Please don't prepend PAYARA to your branch unless you have been given a JIRA ticket to work on* | ||
|
||
If you are working on a GitHub issue a good name for your branch could be issue-### where ### is the number. | ||
|
||
Start working on your project within your IDE and make any changes you wish. | ||
|
||
## Debugging Payara | ||
|
||
Once you have built Payara Server the full distribution will be available within your local repository under the path | ||
|
||
``` | ||
<YourLocalRepo>/appserver/distributions/payara/target/stage | ||
``` | ||
|
||
In order to debug Payara, first build the server with your changes. Run it in debug mode by using the following command: | ||
|
||
``` | ||
./asadmin start-domain --verbose --debug | ||
``` | ||
|
||
From within your IDE you can then attach a debugger to the default port of 9009. | ||
|
||
## Pushing issues to Github | ||
|
||
When you are finished working on your issue, add the files to your git with a comment describing the addressed issue via JIRA and/or the Github issue number: | ||
|
||
``` | ||
git add . [or specify specific files | ||
``` | ||
|
||
``` | ||
git commit -m "fixes #<GithubNumber>" | ||
``` | ||
|
||
Before you merge the branch, ensure that you have updated your master to match the upstream payara. This can be accomplished by using the following: | ||
|
||
First, switch to the master branch: | ||
|
||
``` | ||
git checkout master | ||
``` | ||
|
||
Then synchronise your branch with the changes from master: | ||
|
||
``` | ||
git pull upstream master | ||
``` | ||
|
||
Flip back to your own branch, with your changes: | ||
|
||
``` | ||
git checkout <YourBranchName> | ||
``` | ||
|
||
Merge said changes with the master branch by rebasing your code (effectively a neater marge for private repos): | ||
|
||
``` | ||
git rebase master | ||
``` | ||
|
||
Finally, push the changes from your branch to a new branch on the main repo (origin), with the same name (so as to preserve the issue numbers and history): | ||
|
||
``` | ||
git push origin <YourBranchName> | ||
``` | ||
|
||
## Feature requests and issues | ||
|
||
A large portion of our work is prompted by the actions of the community. If you have an issue which you have found with Payara, or a feature which you would like to be implemented we welcome the raising of github issues. | ||
|
||
## Reporting bugs | ||
|
||
If you find a bug within Payara, please post it as a github issue. Github is our main repository for community found issues with Payara and our support team frequently monitor it for new issues. As with submitting issues, a concise title which clearly explains the issue combined with a comment explaining what the found issue is and either how it arose and a stacktrace of the issue, or a test case which is able to reproduce the issue will help us deliver a patch. | ||
|
||
## Responses | ||
|
||
We continually check the github posted issues for bugs, feature requests, and assorted issues. If you have posted an issue, chances are it has been read by a member of staff. Requests for further information and labels are often posted in order to make it easier for the dev team to see issues. However if your issue has not received a comment or label, don't take this as it having not been read or acted upon! | ||
|
||
## Questions, advice and guidance | ||
|
||
If you have a question on how to use Payara or you need advice and guidance please don't create a GitHub issue. Please post a message on our Google Group which is monitored both by the community and by Payara Engineers. | ||
https://groups.google.com/forum/#!forum/payara-forum |
This file contains 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,58 @@ | ||
# Description # | ||
---------- | ||
|
||
<!--- Brief summary description of the bug or enhancement request --> | ||
|
||
## Expected Outcome | ||
|
||
<!-- If reporting a bug, give a detailed summary of the expected behavior the server and/or deployed applications SHOULD exhibit after executing the steps described below. If possible quote Java EE specification's sections or link to Glassfish or Payara's official documentation as evidence. --> | ||
|
||
<!-- If making an enhancement request, give a detailed explanation of how this new or updated feature should work --> | ||
|
||
## Current Outcome | ||
|
||
<!-- If reporting a bug, give a detailed summary of the actual behavior the server and/or deployed applications exhibit after executing the steps described below. Please put emphasis on any unwanted results. --> | ||
|
||
<!-- If making an enhancement request, explain the drawbacks and disadvantages of the targeted feature (or lack of it) --> | ||
|
||
## Steps to reproduce (Only for bug reports) | ||
|
||
<!-- | ||
Describe the test to reproduce the bug in a series of steps. Make each step simple to follow by describing configuration changes, commands to run or simple instructions; for example: | ||
1 -** Start the domain | ||
./asadmin start-domain payaradomain | ||
2 -** Configure an HTTP network listener in the admin console: | ||
[Attach screenshots of Payara's Server console, to illustrate] | ||
3 -** Make changes to the domain.xml configuration: | ||
<java-config classpath-suffix="" debug-options="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9009" system-classpath=""> | ||
<jvm-options>-XX:MaxPermSize=512m</jvm-options> | ||
<jvm-options>-server</jvm-options> | ||
... | ||
</java-config> | ||
--> | ||
|
||
### Samples | ||
|
||
<!-- Include a link to a [SCCE](http://sscce.org/ "Short, Self-Contained, Correct Example") that helps reproduce the issue faster. Structuring a Maven project is strongly recommended if possible --> | ||
|
||
## Context (Optional) | ||
|
||
<!-- Give details on this issue has affected you, for example: What are you trying to accomplish? | ||
Providing context helps us come up with a solution that is most useful for your scenario. --> | ||
|
||
## Environment ## | ||
|
||
- **Payara Version**: 4.1.1.x | ||
- **Edition**: <!-- Full/Web/Blue/Micro --> | ||
- **JDK Version**: <!-- 6/7/8 uXX - Oracle/IBM/OpenJDK --> | ||
- **Operating System**: <!-- Windows / Linux / Mac --> | ||
- **Database**: <!-- Oracle/MySQL/MariaDB/PostGres/DB2/SQL Server --> | ||
|
This file contains 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 |
---|---|---|
|
@@ -10,3 +10,5 @@ target/ | |
*.iml | ||
.idea | ||
gfbuild.log | ||
/nucleus/payara-modules/requesttracing-core/nbproject/ | ||
nb-configuration.xml |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.