Skip to content

Updated Readme for community #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 46 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
e7b17c1
update to auto build
Apr 30, 2019
a13c452
Update build
Apr 30, 2019
d65c5f7
update build
Apr 30, 2019
eaab7e1
update permissions
Apr 30, 2019
debd3d1
ok
Apr 30, 2019
e267ab4
change git stuff
Apr 30, 2019
fbe6704
push change
Apr 30, 2019
42fedad
change script
Apr 30, 2019
6a4e82d
update push
Apr 30, 2019
6fda98e
just origin
Apr 30, 2019
09cf584
try using the token
Apr 30, 2019
c9d7f79
update push
Apr 30, 2019
afc54ea
add credential helper
Apr 30, 2019
7256f5f
update travis
Apr 30, 2019
9a74f06
new token
Apr 30, 2019
6b7d165
change path
Apr 30, 2019
3384fbf
change url
Apr 30, 2019
cfdd449
back to the begining
Apr 30, 2019
c69eb39
small change
Apr 30, 2019
b9121ef
test
Apr 30, 2019
dc7dff9
on dev
Apr 30, 2019
1e5a714
on dev only
Apr 30, 2019
21fef9d
change conversion
Apr 30, 2019
0f3c8a0
wrong switch
Apr 30, 2019
e8856d8
change travis
Apr 30, 2019
739dec1
markdown2
Apr 30, 2019
694312b
remove swap
May 1, 2019
c21c387
modify build
May 1, 2019
0751ae6
update script
May 1, 2019
ea20818
pathing
May 1, 2019
5dcdb7f
Actually write to the index.html file
May 1, 2019
c6959f3
Update README.md
May 1, 2019
6445cc9
change
May 1, 2019
f49277c
add build scripts
May 1, 2019
742990b
add html snipits
May 1, 2019
b040272
update keys
May 1, 2019
c9f7e49
add links for mailto
May 1, 2019
9ac2f88
Merge branch 'development' into development
May 10, 2019
5b3f145
Merge pull request #6 from zvercodebender/development
May 10, 2019
1fecad9
Update README.md
May 10, 2019
be280c4
Update README.md
May 10, 2019
1b1825d
Merge branch 'development' of https://github.com/xebialabs-community/…
ndebuhr May 10, 2019
b74d9c7
Revert index.html changes, and set the file to the most recent develo…
ndebuhr May 10, 2019
7466004
Merge pull request #8 from xebialabs-community/documentation-refactoring
May 11, 2019
febd82b
Updated in accordance with new license requirement
ankurtrivedi May 5, 2023
87b333d
Update README.md with coding standard link and redline updates
ankurtrivedi May 9, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis-scripts/push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ commit_website_files() {
}

upload_files() {
git remote add origin https://${TRAVIS_PUSH}@github.com/zvercodebender/xebialabs-community.github.io.git > /dev/null 2>&1
git remote add origin https://${TRAVIS_PUSH}@github.com/xebialabs-community/xebialabs-community.github.io.git > /dev/null 2>&1
git push origin HEAD:master
}

Expand Down
6 changes: 4 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ deploy:
branch: development
env:
global:
secure: MBeqsJ9EtCtI8vl5H8L3STKpgZTIbVxfq2uPXjuWIF8ZxbTScJB6/2Emoe4hr/ajtbvKAb66Uoh73dk/2SZSXl9z7N9atGyCMWuT0XBFclWXB4FyTgVSCrXIWPQ+WtQrYK5uVvof4P8bcCzOFKUx2FJZEjC3m1tXskA0qI42SnE=
- secure: NLpl6jyuzsV1VSlozTjpnY9jYAbcfLL0ogfEBfhXFz6iVa3Kt7cnClVhPPglFoCSltGimCmfly8WhsEjLqBTd+466S/mLlFABo3XZ5H7A/bO4DMqdLDqoR8oFWpF+tKMTHZdBgUntUsqlSklicTlDEn3A9QUcLimu/528YikLI32rzd8SFk7QX04rldAdctZW7MJ8fpgzh38sUVgjPsUWe5zdYmKCE41Jx+ln4tHcI858YSk0bBcQP2zjgMF2d+A6YNtemXQ+7u+K+qgDSIujkwFb/c0ZZGFWfslQwl8G19o+V63+8U5cz1oHv7apTa44VzvA6Cgjpzft4D/vrcN9ccVtT9bvL/cKYTbR/MNl0GXpbd0ULO32KD40xVvlWYFj0RojaosaiVbWaraoWyobVDPrjz+dD1ysngPXCAWStC7ksYGL6jhdaE2h5AeY2lYf3XgFluHKMc/dz+yMGr+e+9GEuOMiM7Nuks5jOhJuU+IQ0DXCfmxUswTLLk5EbdMZmN8j3HCAXrYRZvhX1Bxwc4uKkwjm8BG+iO3QvSXxOM5swfe8jwArr3igRVvpbVTHBnI3Ay6u16AWWTTpzMw3NrhlKJWg0689RkndNym8pNpO4i256+sqeM26iN5noqRi50/Xo8w+MrQzMRTJx4TG+XV2GXRgvHaUJmN9kaQLlQ=
- secure: ALn3CbiGF0nkqaXCGG0pQhB1JvbXxAHAVebKzS3W8ueYXklzX6GlV4RcjOpMGDdjBYiH3hH27/kZPUV9OZuWNQHkLCSRVztBgJtcjD6DwAQqqriz47d1y81LfU8wWDDtytap0GWUXBVVGIodXwFU6mCLJJgcPkMGYTHrswZCJDcE89PWJZpo/rUWH/bFBH+8KbttXh20yZXhAZbaSBoBsW9Xw0NdHIlatBU2QvszHKEgraAqcCB3WizSA4RDRrt+2CktZcXPIghzy7RgWBGgEPTCDbDbXni4MWbWxvy6Yh+OmHn2v4rTLUSDjfdQhbwADp5jdZhcOUFlAYrnjVu+6WAVjTp5S5NnSxzt6uamE2To2BYThvwIZ6mECavWoNF4eIZc9eadeXW370mBneTcY1RhwRyfyoQ1ap8hD8ZjwrK1DYRbTiW3Vn3/oQdBvYwRuWlyPp3KukBLhw6wTadTGjP1ZbRptShRD3tpWvu1xL6MudG203rW+TmwILGsfJJp6BkDUFgKDbACjQyPLmEy633j+VMsJZcW+5rsAc2CHkwiVaZCQ/JYfWlNKdRD6vtqiKBIJXMuesr2PuNipiQ7CrudTIGyZqb3eOtXVo+eoozbb5/G/yYP9gAm11BQVzAHuG51lqaRoW2iEvyxqELKWhUTPWzXtd2c7GUseLnz37Y=
- secure: MBeqsJ9EtCtI8vl5H8L3STKpgZTIbVxfq2uPXjuWIF8ZxbTScJB6/2Emoe4hr/ajtbvKAb66Uoh73dk/2SZSXl9z7N9atGyCMWuT0XBFclWXB4FyTgVSCrXIWPQ+WtQrYK5uVvof4P8bcCzOFKUx2FJZEjC3m1tXskA0qI42SnE=
notifications:
slack:
secure: oUSjIwdKHf53VreQhKh36mq8EOHq6i/uhz7qmMdGiu2rhiq+13XqnNsUAnTe/39Cb1LP1Q4I3p8guP+vgG3V5OYv6kO1IEsgpjfhfqLi0tJKfvJx4pjcRB0w+rS+T+JEm75abtgawDT4Pv7v0R7/Yacng72A2ZcwxGWjfJndL9U=
secure: oUSjIwdKHf53VreQhKh36mq8EOHq6i/uhz7qmMdGiu2rhiq+13XqnNsUAnTe/39Cb1LP1Q4I3p8guP+vgG3V5OYv6kO1IEsgpjfhfqLi0tJKfvJx4pjcRB0w+rS+T+JEm75abtgawDT4Pv7v0R7/Yacng72A2ZcwxGWjfJndL9U=
161 changes: 22 additions & 139 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,157 +1,40 @@
### Welcome to XebiaLabs Community Plugins
This page describes how you can contribute to the [XebiaLabs](https://xebialabs.com/) community plugins, where the continuous integration is located and what steps to follow to release your community plugin.
### Welcome to the Digital.ai Developer Community
This page describes how you can contribute to existing integaration of Digital.ai Release and Deploy. The Digital.ai Developer community will be expanding soon with projects for other Digital.ai products and services.

_To join the xebialabs-community organization, create a [GitHub](https://github.com/join) account and request to join the organization with an email to [rbroker@xebialabs.com](mailto:rbroker@xebialabs.com) and [amohleji@xebialabs.com](mailto:amohleji@xebialabs.com)._
To join the DigitalAI-community organization, you will need to create aGitHubaccount, request to join the Digital.ai GitHub organization and execute the Digital.ai Contributor License Agreement (“CLA”). Any Submissions you make to a Digital.ai GitHub organization project or to Digital.ai Software, Inc., its affiliates, assigns and subsidiaries (collectively “Digital.ai”) are subject to the terms of the CLA.

### Quickstart for Existing Plugins

If you want to contribute to an existing repository, simply fork the repository, make your changes, and send a pull request.
If you want to contribute to an existing extension, simply fork the repository, make your changes, and send a pull request.
If you need help with this, contact an existing plugin contributor - for example the person who last committed to that repository.

## Plugin Setup
## Project Submission Requirements

### License
1. You must have a signed Contributor License Agreement on file.
2. Submissions must adhere to the  [coding standards](https://github.com/digital-ai/release-integration-template-python)
3. Refer to the Definition of Done. We use these guidelines internally to ensure that we deliver well-tested, well-documented, and solid code. We encourage you to use this as well!
4. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances that a pull request is merged quickly and without additional clarification requests.
5. Commits must be accompanied by meaningful commit messages.
6. PRs that include bug fixes must be accompanied by a step-by-step description of how to reproduce the bug.
7. PRs that include new logic or new features must be submitted along with Unit/integration test coverage.
8. For large features or changes, open an issue to discuss your proposal first. Notifying us in advance can prevent duplicate or unnecessary effort, and also offers an opportunity to get additional background information and help from other contributors.
9. To report a bug open an issue.
10. Verify that all automated tests on your pull request pass successfully.

XebiaLabs requires that each plugin use the [MIT license](https://opensource.org/licenses/MIT):

```
Copyright <YEAR> <COPYRIGHT HOLDER>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

Licensing can be easily handled using the [Gradle license plugin](https://github.com/hierynomus/license-gradle-plugin):

```
plugins {
id "com.github.hierynomus.license" version "0.13.1"
}
...
license {
header rootProject.file('License.md')
strictCheck false
ext.year = Calendar.getInstance().get(Calendar.YEAR)
ext.name = 'XEBIALABS'
}
```

### Dependencies
We have a public artifact repository which Gradle or Maven can use to fetch dependencies. It is located at <a href="https://dist.xebialabs.com/public/maven2">https://dist.xebialabs.com/public/maven2</a>. A Gradle configuration which uses the repository would look like this:

```
repositories {
...
maven {
url 'http://dist.xebialabs.com/public/maven2'
}
}
```

### Continuous Integration
#### Travis CI
XebiaLabs uses Travis CI for continuous integration. Go to [Travis CI](https://travis-ci.org) and log in with your GitHub account. After you log in, you'll see the community plugins being built. The build configuration is provided by the `.travis.yml` file in each repository. More information is available at the [Travis CI documentation site](http://docs.travis-ci.com/).

When creating the `.travis.yml` file, please configure [Slack](https://slack.com/) notifications as described [here](https://docs.travis-ci.com/user/notifications/#configuring-slack-notifications) and GitHub releases as described [here](http://docs.travis-ci.com/user/deployment/releases/). Use the XebiaLabsCommunityCI system account for GitHub keys.

#### Circle CI
As an alternative, you can use Circle CI.

### Gradle Wrapper
Using a Gradle wrapper ensures that the same Gradle version is used for all builds (including on Travis CI). An example Gradle wrapper can be found in [the xld-openshift-plugin repository](https://github.com/xebialabs-community/xld-openshift-plugin). You can copy the example wrapper or create one yourself using `gradle wrapper`.

Builds should typically be ran with `./gradlew build`.

## Release Outline

### Versioning - Manual/Basic

* Update the `build.gradle` file to contain the new version number.
* Update the `.travis.yml` file to contain the new version number.
* Create a new tag, using [semantic versioning](https://semver.org).
* For example: `git tag -a v4.5.2 -m 'Version 4.5.2' 373159` for commit 373159.
* Push the tag to GitHub: `git push --follow-tags`.

### Versioning - Nebula and Travis

Nebula eliminates the need to set and/or change the version number in the Gradle file. The Travis build will use the version number set in the commit tag. The tags in the repository must be set appropriately by the developer for a major, minor, or patch release using the Nebula conventions.

#### Gradle Config

* Add ```id 'nebula.release' version '6.0.0'``` to the ```plugins``` section of the `build.gradle` file.
* Remove the hard-coded version assignment if present.
* Add scope and useLastTag logic. Note, if it appears that Gradle is not processing these lines, move them higher in the build.gradle file. See the history of the build.gradle file in <https://github.com/xebialabs-community/xlr-ansible-tower-plugin> for an example.

```
if (!project.hasProperty('release.scope')) {
project.ext['release.scope'] = 'patch'
}
if (!project.hasProperty('release.useLastTag')) {
project.ext['release.useLastTag'] = true
}
```

#### Nebula Compatibility of Existing Tags

Check that existing tags meet Nebula conventions. The tag format should be vx.y.z, where x = major release number, y = minor release number, z = patch level. See the Semantic Versioning reference at <https://semver.org>.

#### Travis Config

Edit the .travis.yml file:
* The Travis gem can be installed with ```gem install -v 1.7.5 --no-rdoc --no-ri travis```.
* If the api_key credentials are not working, generate new ones with ```travis setup releases --force``` and the XebiaLabsCommunityCI system account.
* Add ```file_glob: true``` to allow wildcards in the `file:` argument(s).
* Set or change `file` to ```build/distributions/*``` or ```build/libs/*```. The argument can point to a single file (with or without wildcards) or list of files in yml notation.
* Add ```skip_cleanup: true```, so the cleanup doesn't delete the file to be uploaded.
* Add ```on:``` block
```all_branches: true```
```tags: true```
```repo: repo-owner/repo-name```

* Also, ```before_deploy:``` and ```after_deploy:``` blocks are available to run scripts before/after release is pushed.
* Turn on the switch for the repository at https://travis-ci.org/profile/xebialabs-community.

Example:

```
deploy:
provider: releases
api_key:
secure: ...
file_glob: true
file: build/distributions/*
skip_cleanup: true
on:
all_branches: true
tags: true
repo: repo-owner/repo-name
```

#### New Releases

* Confirm a successful build in your local directory.
* Commit the code changes in your local directory, then push them to the GitHub repository.
* Set the [appropriate tag](https://semver.org), e.g., ```git tag -a "v1.3.0" -m "Version 1.3.0"``` for the last commit.
* Execute ```git push --follow-tags```.
* Each push will trigger a Travis job; the second job will add the files listed to the repository's Releases page.
* Consider editing the release notes in GitHub to provide better insight into what's included/important for this release.

## Definition of Done

* Each repository must include the MIT license.
* Each repository must include a Digital.ai approved license.
* Each repository must have a description.
* Each repository must have one or more GitHub topics defined.
* Repository must be named in compliance with our Naming guidelines.
* If your repository is a plugin, the repository name should end with `plugin`.
* If your repository is a plugin for XL Deploy, the repository name should start with `xld`.
* If your repository is a plugin for XL Release, the repository name should start with `xlr`.
* Each repository must have public CI enabled (Travis, CircleCI, or other) and the corresponding badge in the `README.md` file.
* Each repository must include a repository manifest.

## Extra Information

* [XebiaLabs website](https://xebialabs.com/)
* [XebiaLabs documentation](https://docs.xebialabs.com/)
* [XebiaLabs support](https://support.xebialabs.com)
* [XebiaLabs community](https://github.com/xebialabs-community)
* [Digital.ai website](https://digital.ai/)
* [Digital.ai documentation](https://docs.digital.ai/)
* [Digital.ai support](https://support.digital.ai)
* [Digital.ai community](https://github.com/xebialabs-community)
Loading