Skip to content

Latest commit

 

History

History
118 lines (61 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

118 lines (61 loc) · 3.79 KB
Raw

Hacking on the JBoss Migration Center site

Basic Steps

To contribute to jboss.org/migration, fork the repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

     git clone [email protected]:<your-username>/jboss-migration-center.git

  3. Add the remote upstream repository.

     git remote add upstream [email protected]:jboss-developer/jboss-migration-center.git

  4. Get the latest files from the upstream repository.

     git fetch upstream

  5. To update your local master to the latest changes

     git checkout master
 git rebase upstream/master

  6. Create a new topic branch to contain your features, changes, or fixes.

     git checkout -b <topic-branch-name> upstream/master

  7. Contribute new code or make changes to existing files.

  8. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

     git add <changed-filename>
 git commit -m `Description of change...`

    Alternatively, you can use one of the many graphical git clients, such as gitk, gitx, GitHub for Mac etc.

  9. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

     git push origin HEAD

  10. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

Setup your environment

The JBoss Migration Center is built using awestruct, and requires a number of gems.

To setup the environment you need to follow these steps. Certify to use the correct versions.

  1. Install Ruby 1.9.X

    We recommend using RVM, and not your platform provided ruby

  2. Install bundler

     gem install bundler

  3. Install Ruby GEMs

     bundle install

Running the site locally

Having got your environment correctly set up, on windup.jboss.org root, run:

bundle exec awestruct -d

to run awestruct in development mode, and serve the site at http://localhost:4242.

Run

bundle exec awestruct -d --force

to completely rebuild the site, discarding any existing cached output. This is especially useful if you are having problems.

Staging changes

  1. Contact the project lead, and ask for access to filemgmt.jboss.org.

  2. Run ./publish.sh -s

  3. The site will be available at http://jboss.org/migration/staging, which use for staging changes to the site. Staging is normally reserved for verifying minor updates to the site, or for final verification before a major update.

Publishing on Production

  1. Make sure you have Sendmail installed and running. Sendmail will be used to send mail notifications.

On Linux you can install sendmail running: sudo yum install sendmail.

  1. Contact the project lead, and ask for access to filemgmt.jboss.org.

  2. Update the site version on `_config/site.yml' -

  3. Run ./publish.sh -p

  4. The site will be available at http://jboss.org/migration

NOTE: You can also run:

./release.sh -s <old snapshot version> -r <release version>

This will update the version number (step 3), commit and tag and publish the site to http://jboss.org/migration (step 4). Then it will reset the version number back to the snapshot version number.