Skip to content

Commit 55bda95

Browse files
committed
Update README
1 parent e854da2 commit 55bda95

File tree

1 file changed

+75
-75
lines changed

1 file changed

+75
-75
lines changed

aima-all/README.md

Lines changed: 75 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
1-
# AIMA3e-Java aima-all
2-
This project is used solely for creating combined releases of all of the AIMA3e projects.
3-
4-
## CHECK LIST FOR CREATING AN AIMA3e-JAVA RELEASE
5-
6-
### Create the Release
7-
* Checkout the latest version of all the projects into a clean workspace.
8-
* Ensure the revisions # in the build.properties files of each project are updated.
9-
* Ensure the revision #s in the pom.xml file in aima-core is set to match the one in
10-
its build.properties.
11-
* Ensure the README file in each project is updated to reflect the release (i.e.
12-
update the 'Current Release' section at a minimum).
13-
* Commit and push changes to GitHib.
14-
* run the `aima-all.release ant task` from the `aima-all` project.
15-
16-
### Update the JavaDoc
17-
* Upload the latest version of the aima-core Javadoc:<br>
18-
This can be done by running the aima-core.makedocs ant task and replacing
19-
the current generated docs in the `gh-pages` branch:<br>
20-
`aima3e/javadoc/aima-core`
21-
* push the changes to the `gh-pages` branch.
22-
23-
### Update the Java Web Start Applications
24-
25-
* Copy the .jar files generated by the aima-all.release ant task from:<br>
26-
`aima-all/build/release/release` <br>
27-
to the `gh-pages` branch:<br>
28-
`aima3e/jars`
29-
* Create a keystore which will be used to sign the copied jars, e.g.:
30-
```
31-
> keytool -genkey -keystore c:/temp/aima3e.keystore -alias aima3e
32-
33-
> Enter keystore password: <Enter an appropriate password>
34-
> Re-enter new password: <Same password>
35-
> What is your first and last name?
36-
[Unknown]: <Your Name>
37-
> What is the name of your organizational unit?
38-
[Unknown]: AIMA-Java Open Source Project
39-
> What is the name of your organization?
40-
[Unknown]: AIMA-Java Open Source Project
41-
> What is the name of your City or Locality?
42-
[Unknown]: Mountain View
43-
> What is the name of your State or Province?
44-
[Unknown]: California
45-
> What is the two-letter country code for this unit?
46-
[Unknown]: US
47-
> ...
48-
[no]: yes
49-
```
50-
* Sign each jar individually, e.g.:
51-
```
52-
> jarsigner -keystore c:/temp/aima3e.keystore aima-core.jar aima3e
53-
> jarsigner -keystore c:/temp/aima3e.keystore aima-gui.jar aima3e
54-
> jarsigner -keystore c:/temp/aima3e.keystore aimax-osm.jar aima3e
55-
> jarsigner -keystore c:/temp/aima3e.keystore commons-compress-1.1.jar aima3e
56-
```
57-
* push the changes to the `gh-pages` branch.
58-
59-
### Publish the Release to the Maven Central Repository
60-
#### Relevant Background:
61-
* [Deploying via Nexus Guide](http://central.sonatype.org/pages/ossrh-guide.html)
62-
* [The Sonatype/Nexus Open Source Respository](https://oss.sonatype.org/)
63-
* [The Complete Maven Reference](http://www.sonatype.com/books/mvnref-book/reference/public-book.html)
64-
* [The Maven Central Repository](http://search.maven.org/)
65-
* [Maven Home](http://maven.apache.org/)
66-
67-
#### Publish to Maven Central
68-
* Run this command in the aima-core project (currently only releasing this on Maven):<br>
69-
`mvn -P sonatype-oss-release deploy`
70-
* Close and Release. [Follow Releasing to Central from](http://central.sonatype.org/pages/ossrh-guide.html)
71-
72-
## Publish the Release to the AIMA Website
73-
* Upload the .zip file from `aima-all/build/release` to the project's releases page. Delete the previous release.
74-
* Update the AIMA3e `README.md` to indicate the latest revision # (ensure Maven info also updated).
75-
* Update the `AIMA3e Overview` wiki page with the latest release information.
1+
# AIMA3e-Java aima-all
2+
This project is used solely for creating combined releases of all of the AIMA3e projects.
3+
4+
## Check List for creating an AIMA3e-Java Release
5+
6+
### Create the Release
7+
* Checkout the latest version of all the projects into a clean workspace.
8+
* Ensure the revisions # in the build.properties files of each project are updated.
9+
* Ensure the revision #s in the pom.xml file in aima-core is set to match the one in
10+
its build.properties.
11+
* Ensure the README file in each project is updated to reflect the release (i.e.
12+
update the 'Current Release' section at a minimum).
13+
* Commit and push changes to GitHib.
14+
* run the `aima-all.release ant task` from the `aima-all` project.
15+
16+
### Update the JavaDoc
17+
* Upload the latest version of the aima-core Javadoc:<br>
18+
This can be done by running the aima-core.makedocs ant task and replacing
19+
the current generated docs in the `gh-pages` branch:<br>
20+
`aima3e/javadoc/aima-core`
21+
* push the changes to the `gh-pages` branch.
22+
23+
### Update the Java Web Start Applications
24+
25+
* Copy the .jar files generated by the aima-all.release ant task from:<br>
26+
`aima-all/build/release/release` <br>
27+
to the `gh-pages` branch:<br>
28+
`aima3e/jars`
29+
* Create a keystore which will be used to sign the copied jars, e.g.:
30+
```
31+
> keytool -genkey -keystore c:/temp/aima3e.keystore -alias aima3e
32+
33+
> Enter keystore password: <Enter an appropriate password>
34+
> Re-enter new password: <Same password>
35+
> What is your first and last name?
36+
[Unknown]: <Your Name>
37+
> What is the name of your organizational unit?
38+
[Unknown]: AIMA-Java Open Source Project
39+
> What is the name of your organization?
40+
[Unknown]: AIMA-Java Open Source Project
41+
> What is the name of your City or Locality?
42+
[Unknown]: Mountain View
43+
> What is the name of your State or Province?
44+
[Unknown]: California
45+
> What is the two-letter country code for this unit?
46+
[Unknown]: US
47+
> ...
48+
[no]: yes
49+
```
50+
* Sign each jar individually, e.g.:
51+
```
52+
> jarsigner -keystore c:/temp/aima3e.keystore aima-core.jar aima3e
53+
> jarsigner -keystore c:/temp/aima3e.keystore aima-gui.jar aima3e
54+
> jarsigner -keystore c:/temp/aima3e.keystore aimax-osm.jar aima3e
55+
> jarsigner -keystore c:/temp/aima3e.keystore commons-compress-1.1.jar aima3e
56+
```
57+
* push the changes to the `gh-pages` branch.
58+
59+
### Publish the Release to the Maven Central Repository
60+
#### Relevant Background:
61+
* [Deploying via Nexus Guide](http://central.sonatype.org/pages/ossrh-guide.html)
62+
* [The Sonatype/Nexus Open Source Respository](https://oss.sonatype.org/)
63+
* [The Complete Maven Reference](http://www.sonatype.com/books/mvnref-book/reference/public-book.html)
64+
* [The Maven Central Repository](http://search.maven.org/)
65+
* [Maven Home](http://maven.apache.org/)
66+
67+
#### Publish to Maven Central
68+
* Run this command in the aima-core project (currently only releasing this on Maven):<br>
69+
`mvn -P sonatype-oss-release deploy`
70+
* Close and Release. [Follow Releasing to Central from](http://central.sonatype.org/pages/ossrh-guide.html)
71+
72+
## Publish the Release to the AIMA Website
73+
* Upload the .zip file from `aima-all/build/release` to the project's releases page. Delete the previous release.
74+
* Update the AIMA3e `README.md` to indicate the latest revision # (ensure Maven info also updated).
75+
* Update the `AIMA3e Overview` wiki page with the latest release information.
7676
* Send an email to team members letting them know the release has gone out the door.

0 commit comments

Comments
 (0)