-
Notifications
You must be signed in to change notification settings - Fork 5
/
params.json
1 lines (1 loc) · 3.49 KB
/
params.json
1
{"name":"Xebialabs-community.github.io","tagline":"xebialabs-community pages","body":"### Welcome to XebiaLabs Community plugins\r\nThis page describes how you can contribute to the XebiaLabs Community plugins, where the continuous integration is located and what steps to follow to release your community plugin.\r\n\r\n### Join the xebialabs-community organization\r\nCreate a github account, and request to join the organization by sending an email to [email protected].\r\n\r\n### Fork a repo or generate a pull request\r\nIf you want to contribute to an existing repository, simply fork the repository, make your changes and send a pull request.\r\nIf you need help on this, you can contact for example the person who has done the latest commits to that repository.\r\n\r\n### License to be used\r\nCurrently we want each plugin to have the following license information maintained:\r\n\r\n```\r\nTHIS CODE AND INFORMATION ARE PROVIDED \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR \r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS \r\nFOR A PARTICULAR PURPOSE. THIS CODE AND INFORMATION ARE NOT SUPPORTED BY XEBIALABS.\r\n```\r\n\r\nThis can easily be done using the gradle license plugin https://github.com/hierynomus/license-gradle-plugin\r\n\r\n```\r\nbuildscript {\r\n repositories {\r\n jcenter()\r\n }\r\n dependencies {\r\n classpath \"nl.javadude.gradle.plugins:license-gradle-plugin:0.11.0\"\r\n }\r\n}\r\n\r\napply plugin: \"com.github.hierynomus.license\"\r\n```\r\n\r\n\r\n### Continuous Integration\r\n#### Travis CI\r\nWe use travis ci as Continuous Integration tool. You can simply browse to https://travis-ci.org and login via your github account. Once logged in, you'll see all our community plugins being build. The configuration for that can be found in the `.travis.yml` file within each repository.\r\nMore information can be found at http://docs.travis-ci.com/. Please also configure hipchat notifications as described in here: http://docs.travis-ci.com/user/notifications/#HipChat-notification (TravisCI room) and github releases as described here: http://docs.travis-ci.com/user/deployment/releases/.\r\n#### BuildHive\r\nAs an alternative you can also use BuildHive (Jenkins in the Cloud for open source). https://buildhive.cloudbees.com although using BuildHive it is probably not possible to integrate with HipChat and send releases back to GitHub.\r\n\r\n### Use a gradle wrapper\r\nAn example usage of a gradle wrapper can be found in the xld-cloudfoundry-plugin repository. Using a gradle wrapper makes sure we are always using the same gradle version, also on Travis. You can copy the example wrapper from the xld-cloudfoundry-plugin repository or create one yourself using `gradle wrapper`.\r\n\r\n### Release your plugin\r\nMake sure you follow these steps\r\n\r\n* Update the `build.gradle` file to contain the new version number\r\n* Update the `.travis.yml` file to contain the new version number\r\n* Create a new tag. Example `git tag -a v4.5.2 -m 'Version 4.5.2' 373159`\r\n* Push the tag to github: `git push --tags`\r\n\r\n### Rules to follow\r\n\r\n* Each repository must have the license somewhere included\r\n* If your repository is a plugin, the repo name should end with `plugin`\r\n* If your repository is a plugin for XL Deploy, it should start with `xld`\r\n* If your repository is a plugin for XL Release, it should start with `xlr`\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}