JBoss Development Process Guide
Next
JBoss Development Process Guide
2004, Ivelin Ivanov, Ryan Campbell, Pushkala Iyer
2005
Table of Contents
Preface
1. Overview
1.1. Background
1.2. JEMS integration milestones
2. JBoss Issue Tracking
2.1. Creating a new Project
2.2. Creating Release Notes
2.2.1. Adding Issues to Release Notes
2.2.2. Generating Release Notes
2.3. Issues
2.3.1. Types
2.3.2. Priorities
2.3.3. Estimates and Due Dates
2.3.4. Affects Checkboxes
2.4. Managing Container Projects
2.5. Project Source Repository and Builds
2.6. Testsuites
2.7. Dependency Tracking with JIRA
3. Project Structure
4. Build System Requirements
4.1. Definitions
4.2. Goals
4.2.1. Project Decomposition
4.2.2. Dependency Management
4.2.3. Simplified Build Scripts
4.2.4. Tool Compatibility
4.3. Requirements
4.3.1. Declarative Dependencies
4.3.2. Automated Updates
4.3.3. Source Artifact Overrides
4.3.4. Dependency Version Reconciliation
4.3.5. Component Builds
4.3.6. Extensibility
4.3.7. Incremental Builds
4.3.8. Artifact JDK Version
4.3.9. Line-Precise Error Reporting
4.4. Use Cases
4.4.1. Intial Project Checkout & Build
4.4.2. Source Override
4.4.3. JBossCache Example
4.4.4. Valid Commit
4.4.5. Broken Build: Interface Changes
5. Build Reference
5.1. Overview and Concepts
5.2. Component Build
5.2.1. Component Info Elements Reference
5.2.2. Component Definition Elements Reference
5.2.2.1.
5.3. How to Synchronize and Build
5.4. Tutorial: Anatomy of a Component Build
5.4.1. Top Level Build
5.4.2. Component Level Build
5.4.2.1. Defining an Artifact
5.4.3. Placing an Artifact in the Release
5.5. How to Add a Component to the Repository
6. CVS Access for JBoss Sources
6.1. Obtaining a CVS Client
6.2. Anonymous CVS Access
7. Coding Conventions
7.1. Templates
7.1.1. Importing Templates into the Eclipse IDE
7.2. Some more general guidelines
7.3. JavaDoc recommendations
8. Logging Conventions
8.1. Obtaining a Logger
8.2. Logging Levels
8.3. Log4j Configuration
8.3.1. Separating Application Logs
8.3.2. Specifying appenders and filters
8.3.3. Logging to a Seperate Server
8.3.4. Key JBoss Subsystem Categories
8.3.5. Redirecting Category Output
8.3.6. Using your own log4j.xml file - class loader scoping
8.3.7. Using your own log4j.properties file - class loader scoping
8.3.8. Using your own log4j.xml file - Log4j RepositorySelector
8.4. JDK java.util.logging
9. JBoss Test Suite
9.1. How To Run the JBoss Testsuite
9.1.1. Build JBoss
9.1.2. Build and Run the Testsuite
9.1.3. Running One Test at a Time
9.1.4. Clustering Tests Configuration
9.1.5. Viewing the Results
9.2. Testsuite Changes
9.2.1. Targets
9.2.2. Files
9.3. Functional Tests
9.3.1. Integration with Testsuite
9.4. Adding a test requiring a custom JBoss Configuration
9.5. Tests requiring Deployment Artifacts
9.6. JUnit for different test configurations
10. Support, Sales Force and Patch Management
10.1. An overview of the Support Process
10.2. Patch Management
10.3. Monitoring the Support Process
11. Weekly Status Reports
12. Documentation and the Documentation Process
12.1. JBoss Documentation
12.2. Producing and Maintaining Quality Documentation
12.2.1. Responsibilities
12.2.1.1. The product team
12.2.1.2. The documentation team
12.2.2. Product documentation review
12.2.3. Keep the documentation up-to-date
12.2.4. Articles and books
12.2.5. Authoring JBoss Documentation using DocBook