Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: jruby/jruby
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 30783af23dad
Choose a base ref
...
head repository: jruby/jruby
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 92efdb665ae8
Choose a head ref
  • 2 commits
  • 1 file changed
  • 2 contributors

Commits on Aug 7, 2017

  1. BUILDING.md: Markdown formatting, copy-edits 

      - [ci skip]
    @olleolleolle
    olleolleolle authored Aug 7, 2017
    Copy the full SHA
    b8b43ea View commit details

  2. Merge pull request #4735 from olleolleolle/patch-1 

    BUILDING.md: Markdown formatting, copy-edits
    @enebo
    enebo authored Aug 7, 2017
    Copy the full SHA
    92efdb6 View commit details
Showing with 24 additions and 25 deletions.
  1. +24 −25 BUILDING.md
49 changes: 24 additions & 25 deletions BUILDING.md
View file
Original file line number Diff line number Diff line change
@@ -180,9 +180,9 @@ mvn -Pdist -Dinvoker.skip=false

JRuby runs CI tests on TravisCI. See [.travis.yml](https://github.com/jruby/jruby/blob/master/.travis.yml).

#### maven integration tests - -Pjruby-complete or -Pmain
#### Maven integration tests - -Pjruby-complete or -Pmain

maven integration test will use the packed maven artifact to run the tests in a forked maven instance. these maven projects are locatated in
maven integration tests will use the packed maven artifact to run the tests in a forked maven instance. These maven projects are locatated in

```
maven/jruby/src/it
@@ -191,7 +191,7 @@ maven/jruby-jars/src/it
maven/jruby-dist/src/it
```

to trigger the tests with the build:
To trigger the tests with the build:

```
mvn -Pmain -Dinvoker.skip=false
@@ -200,8 +200,7 @@ mvn -Pdist -Dinvoker.skip=false
mvn -Pjruby-jars -Dinvoker.skip=false
```

to pick a particular test add the name of the directory inside the respective *src/it* folder, like (wildcards are possible):

To pick a particular test, add the name of the directory inside the respective *src/it* folder, like (wildcards are possible):

```
mvn -Pmain -Dinvoker.skip=false -Dinvoker.test=integrity
@@ -212,21 +211,21 @@ mvn -Pmain -Dinvoker.skip=false -Dinvoker.test=osgi*
Clean Build
-----------

To clean the build it is important to use the same profile for the clean as what you want to build. the best way to clean build something is, i.e. jruby-jars
To clean the build it is important to use the same profile for the clean as what you want to build. The best way to clean build something is, i.e. jruby-jars

```
mvn clean install -Pjruby-jars
```

this first cleans everything and then starts the new build in one go !
This first cleans everything and then starts the new build in one go!

Cleaning the build may be necessary after switching to a different
version of JRuby (for example, after switching git branches) to ensure
that everything is rebuilt properly.

NOTE: ```mvn clean``` just cleans the **jruby-core** artifact and the **./lib/jruby.jar** !
NOTE: ```mvn clean``` just cleans the **jruby-core** artifact and the **./lib/jruby.jar**!

clean everything:
Clean everything:

```
mvn -Pclean
@@ -235,67 +234,67 @@ mvn -Pclean
Distribution Packages
---------------------

all distribution packages need maven-3.3.x or the use of supplied maven wrapper. all examples below will show the use of the maven wrapper.
All distribution packages need maven-3.3.x or the use of supplied maven wrapper. All examples below will show the use of the maven wrapper.

###the tar.gz and zip distribution packages###
### The tar.gz and zip distribution packages

```
./mvnw -Pdist
```

the files will be found in ./maven/jruby-dist/target
The files will be in `./maven/jruby-dist/target`.

###jruby-complete.jar###
### `jruby-complete.jar`

```
./mvnw -Pcomplete
```

the file will be in ./maven/jruby-complete/target
The file will be in `./maven/jruby-complete/target`.

###jruby maven artifacts###
### jruby maven artifacts

```
./mvnw -Pmain
```

and those files will be installed in you maven local-repository ready to use with maven, ivy, buildr, etc
And those files will be installed in your maven local-repository ready to use with maven, ivy, buildr, etc.

###jruby jars gem###
### jruby jars gem

```
./mvnw -Pjruby-jars
```

the gem will be in ./maven/jruby-jars/pkg
The gem will be in `./maven/jruby-jars/pkg`.

### building ALL packages ###
### Building ALL packages

```
./mvnw -Pall
```

### cleaning the build ###
### Cleaning the build

this will also clean the **ext** directories, i.e. a new build will then use the latest code from there for **lib/ruby**
This will also clean the **ext** directories, i.e. a new build will then use the latest code from there for **lib/ruby**.

```
./mvnw -Pclean
```

## release ##
## Release

first set the new version in the file *VERSION* inside the root directory and then to deploy the maven artifact to sonatype oss execute:
First set the new version in the file *VERSION* inside the root directory and then to deploy the maven artifact to sonatype oss execute:

```
./mvnw clean deploy -Psonatype-oss-release
```

go to oss.sonatype.org and close the deployment which will check if all 'required' files are in place and then finally push the release to maven central and . . .
Go to https://oss.sonatype.org/ and close the deployment, which will check if all 'required' files are in place and then finally push the release to Maven Central and . . .

### Start a new version

After the release set the new development version in *VERSION* and generate the pom.xml files
After the release, set the new development version in *VERSION* and generate the `pom.xml` files:

```
./mvnw