You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/about/CONTRIBUTING.md
+43-1Lines changed: 43 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,7 @@ Changes are welcome from all members of the Community.
25
25
26
26
**Note:** Getting changes from others requires [Syncing your Local repository](https://help.github.com/articles/syncing-a-fork) with Master utPLSQL repository. This can happen at any time.
27
27
28
+
28
29
## Coding Standards ##
29
30
30
31
* Snake case will be used. This separates keywords in names with underscores. `execute_test`
@@ -39,7 +40,48 @@ Changes are welcome from all members of the Community.
39
40
* Nested Tables start with `tt_`
40
41
* varchar2 lengths are set in characters not bytes
41
42
42
-
43
+
44
+
## Testing Environment ##
45
+
46
+
We are using docker images to test utPLSQL on our Travis CI builds. The following versions of Oracle Database are being used.
47
+
48
+
* 11g XE R2
49
+
* 12c SE R1
50
+
* 12c SE R2
51
+
52
+
These images are based on the official dockerfiles released by Oracle, but due to licensing restrictions, we can't make the images public. You can build your own and use it locally, or push to a private docker repository.
53
+
54
+
The build steps are simple if you already have some experience using Docker. You can find detailed information about how to build your own image with a running database in: [example of creating an image with pre-built DB](https://github.com/oracle/docker-images/blob/master/OracleDatabase/samples/prebuiltdb/README.md)
55
+
56
+
> You can find more info about the official Oracle images on the [Oracle Database on Docker](https://github.com/oracle/docker-images/tree/master/OracleDatabase) GitHub page.
57
+
58
+
> If you are new to Docker, you can start by reading the [Getting Started With Docker](https://docs.docker.com/engine/getstarted/) docs.
59
+
60
+
### Build Notes ###
61
+
* You may not forget to comment out the VOLUME line. This step is required, because VOLUMES are not saved using `docker commit` command.
62
+
63
+
* When the build proccess is complete, you will run the container to install the database. Once everything is set up and you see the message "DATABASE IS READY!", you may change the password and stop the running container. After the container is stopped, you can safely commit the container.
64
+
65
+
* You can use the --squash experimental docker tag to reduce the image size. Example:
Travis will use your Docker Hub credentials to pull the private images, and the following secure environment variables must be defined.
71
+
72
+
Variable | Description
73
+
---------|------------
74
+
**DOCKER_USER****DOCKER_PASSWORD** | _Your Docker Hub website credentials. They will be used to pull the private database images._
75
+
76
+
### SQLCL ###
77
+
78
+
Our build configurarion uses SQLCL to run the scripts, and you need to configure a few additional secure environment variables. After the first build, the downloaded file will be cached.
79
+
80
+
Variable | Description
81
+
---------|------------
82
+
**ORACLE_OTN_USER ORACLE_OTN_PASSWORD** | _Your Oracle website credentials. They will be used to download SQLCL._
83
+
84
+
43
85
## New to GIT ##
44
86
45
87
If you are new to GIT here are some links to help you with understanding how it works.
0 commit comments