alexeykazakov/jbosstools-devdoc

Developer documentation/Contributor guides for JBoss Tools developers

JBoss Tools Developer Documentation

This repository contains documentation for building and developing JBoss Tools.

It is meant to replace the articles related to development at jboss.org wiki found at https://community.jboss.org/wiki/JBossTools

See Contributing for how to write/add to these docs.

This repo should be considered a wiki, into which all developers can push docs. External contributors can do pull requests or report issues to improve the quality, clarity, and breadth of this documentation.

Table of Contents

• Getting Started

  • Setting up the eclipse development environment.

  • Configuring your git workflow.

  • Using target platforms in eclipse

• Target Platforms

  • Using target platforms in eclipse

  • Target platform update process

    • Creating a new dependency mirror

  • Target platform release process

• Building a project (also called module or component)

  • JBoss Tools Build FAQ

  • Building from the command line

  • Building with Eclipse (using m2e)

  • How to build source bundles, features, and source zips

  • How to build the whole JBoss Tools cascade / stack of projects

    • List of projects in JBoss Tools / Red Hat JBoss Developer Studio

  • Exporting plugins from eclipse

  • All about Tycho

    • How to test new versions of Tycho

• Testing & Debugging

  • Debugging via Eclipse runtime workbench

  • Installing a local build to Eclipse

  • Testing an installed build

  • Tracing and logging in Eclipse

    • How to gather Eclipse logs and system configuration details

    • How to enable tracing in Eclipse

  • Using the Eclipse remote debugger

  • Debugging maven (surefire) tests

  • Debugging on a remote server (via SSH or VNC)

• Source and Project Management

  • Adding a new module / repository to JBoss Tools or JBDS

  • Adding a new plugin or feature to an existing JBoss Tools 4.x module

  • Adding a new unit or integration test and test feature

  • Requesting Target Platform Updates

  • Adding an update site or associate site

  • Publishing features to JBoss Tools, Red Hat JBoss Developer Studio, JBoss Central, Early Access, and Eclipse Marketplace

  • Bundling Third Party Library Dependencies

  • Versioning Rules

    • Versioning Rules (Plugins, features, products, installers, update sites)

    • Versioning Rules for Build Artifacts (Parent pom, foundation.core, core.central, ide-config.properties)

  • Updating Versions for Components

• Process and Protocol

  • How to use JIRA

  • Code freezes

  • Release guidelines

  • Tagging & branching

• API

  • Exposing And Migrating API

  • Common APIs You May Need

    • Foundation - Base Classes for Every Plugin

    • Usage tracking

    • Proxy Wizards

• Community contribution and involvement

Secrets

The folder secrets contains usernames and password for various services used by JBoss Tools. Encrypted and managed with blackbox tool for easy use of GPG based encryption.

To edit/view install blackbox and use blackbox_edit <filename> to see the decrypted content.

If you cannot edit/view the content you need someone with admin access to add you to the repo.

To generate key: gpg --gen-key

Then register the email used as admin:

blackbox_addadmin <email>

From then on you should be able to edit with blackbox_edit.

Other documents

Many of these docs are old and need to be updated, or to be moved to better categories.

• How to build JBoss Tools 4.x documentation

• How to build JBoss Tools 4.0