ENTERPRISE-61: Add Jenkins integration build faild documentation #113
Conversation
codenvy-docs.iml
Outdated
| @@ -0,0 +1,22 @@ | |||
| <?xml version="1.0" encoding="UTF-8"?> | |||
There was a problem hiding this comment.
Why is this file needed? What does it do?
There was a problem hiding this comment.
Oops. IntelliJ file. Needs to be removed.
There was a problem hiding this comment.
@vinokurig and @eivantsov I committed some tweaks to the docs page to make it more readable. Please ensure that all documentation is still accurate.
| @@ -7,41 +7,56 @@ permalink: /:categories/continuous-integration/ | |||
| --- | |||
| {% include base.html %} | |||
|
|
|||
| Codenvy is connected to your repo so any change made to the repo that would normally trigger a CI job will continue to trigger a CI job when the change is made in Codenvy. | |||
| Codenvy can use [Factories]({{base}}{{site.links["factory-getting-started"]}}) with a Jenkins CI system to generate developer workspaces pre-configured with the context of the CI job. For example, a failed CI build email can be customized to include a link to two factories that open a workspace pre-configured to: | |||
| * The branch and commit ID that broke the build for the project. | |||
There was a problem hiding this comment.
branch is not present in failed build factory. Project in factory will be checked out to commit.
There was a problem hiding this comment.
The branch isn't specified in the Factory, but if the jenkins build is for a specific branch then the factory will use that branch, right?
There was a problem hiding this comment.
I think I have corrected this now, please review.
| Codenvy is connected to your repo so any change made to the repo that would normally trigger a CI job will continue to trigger a CI job when the change is made in Codenvy. | ||
| Codenvy can use [Factories]({{base}}{{site.links["factory-getting-started"]}}) with a Jenkins CI system to generate developer workspaces pre-configured with the context of the CI job. For example, a failed CI build email can be customized to include a link to two factories that open a workspace pre-configured to: | ||
| * The branch and commit ID that broke the build for the project. | ||
| * The head of the master branch for the project. |
There was a problem hiding this comment.
Head factory points to developer branch, not master https://nightly.codenvy-stg.com/docs/integration-guide/continuous-integration/index.html#create-a-codenvy-factory
There was a problem hiding this comment.
That link doesn't clarify things for me. If the jenkins job is setup to build master then the head factory will open with a clone of master, won't it? If the jenkins job is setup to build "brad" branch then the factory will open with a clone of "brad" right?
There was a problem hiding this comment.
HEAD of branch. master is a branch too. So, if it is master then it is head of master.
|
|
||
| #### For GitHub | ||
|
|
||
| Update the `codenvy.env` with `GitHub` webhooks properties. Note that you can rename "WEBHOOK1" with any identifier. Webhooks are tied to connectors through Factory IDs. There can be multiple webhooks (if you need to receive webhooks from multiple repositories) - in this case, add a new entry with a different name for WEBHOOKID and FACTORY1_ID. |
There was a problem hiding this comment.
in this case, add a new entry with a different name for WEBHOOKID and FACTORY1_ID.
I would remove FACTORY1_ID from this description, it is described below
|
|
||
| ```text | ||
| CODENVY_GITHUB_WEBHOOK_WEBHOOK1_REPOSITORY_URL=https://github.com/example/testrepo.git | ||
| CODENVY_GITHUB_WEBHOOK_WEBHOOK1_FACTORY1_ID=factory1Id | ||
| ``` | ||
|
|
||
| One webhook can update more than one Factory which can be added to configuration with a different Factory identifier, for example `FACTORY2_ID`: | ||
| One webhook can update more than one Factory. Add a different Factory identifier, for example `FACTORY2_ID`: |
There was a problem hiding this comment.
I would rephrase this:
Each webhook can update more than one Factory - in this case, add a new entry with a FACTORY_ID, where N is incremented number of the factory in the current group of entries, for example ...
the same for Bitbucket Server webhooks
There was a problem hiding this comment.
Okay - I also noticed that the BitBucket Server section was using a github URL so I replaced that.
|
|
||
| #### BitBucket Server | ||
|
|
||
| Update the `codenvy.env` with `Bitbucket Server` webhooks properties. Webhooks are tied to connectors through Factory IDs. There can be multiple webhooks (if you need to receive webhooks from multiple repositories) - in this case, add a new entry with a different name for WEBHOOKID and FACTORY1_ID. |
There was a problem hiding this comment.
FACTORY1_ID is not needed here, see comment above
|
@bmicklea please review my comments |
Add Jenkins integration build faild documentation