From 77d4927e2d2b4dedb3da1850ae804b2b4e6db87e Mon Sep 17 00:00:00 2001 From: nfarrantdiaz Date: Thu, 2 Jun 2016 13:44:06 -0400 Subject: [PATCH] Update README with issues --- README.md | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index aff6b3e..011e9b9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # APEX_test_application -Scripts for bringing Oracle Application Express applications into version control, any version control tool may be used. Scripts designed to work for Linux and OSX (Will not work on Windows) - +Scripts for bringing Oracle Application Express applications into version control, any version control tool may be used. Scripts designed to work for Linux and OSX (Will not work on Windows). These scripts were designed using this paper as reference: +http://www.rwijk.nl/AboutOracle/psdua.pdf +. If you have questions about workflow or any other concepts you should look there before posting. ## Setup #### Required files and environment variables @@ -28,16 +29,33 @@ Switches which config file is being used ##### npm run read-conf-file Outputs the name and contents of the config file currently being used +###Workflow +--- +TODO write workflow section + ###Config File Explained +--- May later add this section explaining each of the config parameters ###Known Issues +--- #### Deleting a page will always win merges -**To Reproduce**: - * Have two developers working on different versions of an app (i.e. working on different features to be - * Developer 1 deletes a page in the app and pushes to the project's repo - * Developer 2 merges developer 1's changes and decides to keep the deleted page in the merge - * When developer 2 reinstalls the app into apex the page will still be deleted -**Why it occurs** - * +**To Reproduce**: +* Have two developers working on different versions of an app (i.e. working on different features to be added). +* Developer 1 deletes a page in the app and pushes to the project's repo. +* Developer 2 merges developer 1's changes and decides to keep the deleted page in the merge. +* When developer 2 reinstalls the app into apex the page will still be deleted. +**Why it occurs**: + +Since a page was deleted, it's removed from the install.sql script generated by apex. When git sees the merge of the two developers, only one has changed the install.sql script so it automatically applies those changes to the merge meaning the page is no longer called during install so it's never created in your apex application. + +**How to avoid**: + +Be extremely cautious when deleting pages and consult with your teammates first + +**How to fix**: + +If you do end up accidently deleting a page then you will have to manually re-add the install lines to the install.sql + +#### Random version control noise in application meta-data