Skip to content

Commit 4496449

Browse files
authored
Merge pull request #224 from oracle/doc-branching
Updates for branching and using Wercker
2 parents 9e2990e + b7cee73 commit 4496449

File tree

2 files changed

+58
-1
lines changed

2 files changed

+58
-1
lines changed

site/developer.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,24 @@ To clone the repository from GitHub, issue this command:
2525
git clone https://github.com/oracle/weblogic-kubernetes-operator.git
2626
```
2727

28+
## Operator branching model
29+
30+
The ```master``` branch is protected and will always contain source for the latest, generally available (GA)
31+
release of the operator, including any critical hot fixes. No general pull requests will be merged to this branch.
32+
33+
Active work will be performed on the ```develop``` branch. This branch is also protected. Please submit pull
34+
requests to this branch unless you are collaborating on a feature and have another target branch.
35+
Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests on the [README] (README.md).
36+
37+
Longer running feature work will be performed on specific branches, such as ```feature/dynamic-clusters```. Since we want
38+
to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we
39+
encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into
40+
their own shorter-lived branches and create pull requests to ```develop``` when these smaller work items are complete.
41+
42+
When it is time for a release, we will branch off ```develop``` to create a per-release branch. Here, we will update version
43+
numbers, rebuild javadoc, if necessary, and perform any other pre-release updates. Finally, this release branch will be merged
44+
to ```master```.
45+
2846
## Building the operator
2947

3048
The operator is built using [Apache Maven](http://maven.apache.org). The build machine will also need to have Docker installed.

site/installation.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,46 @@ Note that there is a short video demonstration of the installation process avail
1111
[comment]: # ( Note that you *must* create the `docker-registry` secret in the `weblogic-operator` namespace, so you will need to create the namespace first. )
1212
[comment]: # ( In this command, replace the uppercase items with the appropriate values. The `SECRET_NAME` will be needed in later parameter files. The `NAMESPACE` must match the namespace where the operator will be deployed. )
1313

14-
## Build the Docker image for the operator
14+
## Build the Docker image for the operator using Wercker
15+
16+
You can build, test, and publish the Docker image for the operator directly from Wercker using the ```wercker.yml``` from this repository.
17+
18+
If you haven't done so already, navigate to [wercker.com](https://www.wercker.com) and create an account. Once you are logged in,
19+
on the [app.wercker.com] (https://app.wercker.com) page press, "Create your first application."
20+
21+
Select GitHub (the default, if you are new to Wercker). If you haven't done so already, press the "Connect" button within the
22+
larger GitHub button and follow the prompts to provide a login for GitHub. This connects your Wercker and GitHub accounts so
23+
that Wercker pipelines will later be able to clone this repository. Press, "Next."
24+
25+
Select the repository from GitHub. This will be "oracle / weblogic-kubernetes-operator" or a different value if you
26+
forked this repository. Press, "Next."
27+
28+
Configure Wercker's access to the GitHub repository. The default choice, "wercker will check out the code without using an SSH key",
29+
is typically sufficient. Press, "Next."
30+
31+
Verify the settings so far on the review page and press, "Create."
32+
33+
Since this GitHub repository already has a ```wercker.yml``` file, you can skip directly to the "Environment" tab.
34+
35+
Please provide the following key/value pairs on the environment page. Remember that these values will be
36+
visible to anyone to whom you give access to the Wercker application, therefore, select "Protected" for any
37+
values that should remain hidden, including all passwords.
38+
39+
| Key | Value | OCIR Sample |
40+
| --- | --- | --- |
41+
| DOCKER_USERNAME | Username for the Docker store for pulling serverjre image | |
42+
| DOCKER_PASSWORD | Password for the Docker store | |
43+
| REPO_REGISTRY| Registry address | https://phx.ocir.io/v2 |
44+
| REPO_REPOSITORY | Repository value | phx.ocir.io/<your tenancy>/weblogic-kubernetes-operator |
45+
| REPO_USERNAME | Username for registry | <your tenancy>/<your username> |
46+
| REPO_PASSWORD | Password for registry | Use generated SWIFT password |
47+
| IMAGE_TAG_OPERATOR | Image tag, such as 0.2 or latest | |
48+
49+
Select the "Runs" tab. Skip to the bottom and press, "Trigger your first build now."
50+
51+
When the run completes successfully, the Docker image for the operator will be built and published to your repository.
52+
53+
## Build the Docker image for the operator locally
1554

1655
The following software are required to obtain and build the operator:
1756

0 commit comments

Comments
 (0)