Environments and Version Control in EE - The Why and How

ENVIRONMENTS &VERSION CONTROL The Why & How ERIKREAGAN • EECI

WHO IS THIS GUY? EE Reactor team member2 ERIKREAGAN • EECI

WHO IS THIS GUY? Partner & Lead Developer3 ERIKREAGAN • EECI

Survey Submissions4 78 ERIKREAGAN • EECI

SURVEY SUBMISSIONS Web Development Experience 35 6-10 years 24 3-5 years 19 Over 10 years5 ERIKREAGAN • EECI

SURVEY SUBMISSIONS ExpressionEngine Experience 40 3-4 years 19 0-2 years 12 5-7 years 4 pMachine 3 None6 ERIKREAGAN • EECI

SURVEY SUBMISSIONS Weekly Responsibilities 66 HTML/CSS/JS markup 64 EE site planning 38 PHP/MySQL development 21 Add-on development 20 Content management 19 Team leader7 ERIKREAGAN • EECI

Caught my Monty Python reference8 73% ERIKREAGAN • EECI

VERSION CONTROL9 ERIKREAGAN • EECI

SYNONYMS • Version Control • Revision Control • Source Control10 ERIKREAGAN • EECI

COMMON SYSTEMS • Git • Subversion • Mercurial11 ERIKREAGAN • EECI

SURVEY STATS12 ERIKREAGAN • EECI

Devs not currently using a VCS regularly13 34% ERIKREAGAN • EECI

Devs only using a desktop GUI for VCS14 21% ERIKREAGAN • EECI

Devs only using command line for VCS15 21% ERIKREAGAN • EECI

Devs using both CLI and a GUI for VCS16 24% ERIKREAGAN • EECI

Have used CVS17 6% ERIKREAGAN • EECI

Have used Mercurial18 13% ERIKREAGAN • EECI

Have used Subversion19 54% ERIKREAGAN • EECI

Have used Git20 77% ERIKREAGAN • EECI

WE USE GIT Linux jQuery Rails Android21 ERIKREAGAN • EECI

WE USE GIT And so do the cool kids Linux jQuery Rails Android21 ERIKREAGAN • EECI

OLD WAY Single Developer 1. Duplicate index.html 2. Test changes 3. (Maybe save a backup of the previous version) 4. Save over old version losing previous state22 ERIKREAGAN • EECI

NEW WAY Single Developer 1. Change and save the ﬁle contents (Retain history of ﬁle for future use)23 ERIKREAGAN • EECI

OLD WAY Development Team 1. Bob changes part of index.html 2. Suzie changes a diﬀerent part of index.html 3. Bob and Suzie carefully merge changes together 4. Overwrite old version of index.html24 ERIKREAGAN • EECI

NEW WAY Development Team 1. Change and save the ﬁle contents (Retain history of ﬁle for future use)25 ERIKREAGAN • EECI

26 ERIKREAGAN • EECI

KEY CONCEPTS • Track certain ﬁles • Ignore certain ﬁles • Commits (History) • Branches • Remote branches27 ERIKREAGAN • EECI

“WHAT DO I TRACK?” VS “WHAT DO I IGNORE?”28 ERIKREAGAN • EECI

IGNORED FILES • Operating System ﬁles • Caches • .htaccess (possibly) • Custom uploads from EE • Dynamic images (captchas etc)29 ERIKREAGAN • EECI

.gitignore # Lame OS files Thumbs.db .DS_Store # EE System cache /system/expressionengine/cache/* # Local dev database file /config/config.local.php # Custom Upload Directories /public_html/uploads/* # Captchas /public_html/images/captchas # Asset minification /public_html/min30 ERIKREAGAN • EECI

TRACKED FILES • EE System directory • Add-ons • Template ﬂat ﬁles • Images, CSS, Javascript & other assets31 ERIKREAGAN • EECI

COMMITS Create your history32 ERIKREAGAN • EECI

COMMIT TIPS • Commit o en (common Git practice) • Write detailed commit messages • Review commit log when returning to a project a er a break of any sort • Review commits of development team members33 ERIKREAGAN • EECI

BAD COMMIT MESSAGE Updated config file.34 ERIKREAGAN • EECI

GOOD COMMIT MESSAGE Updated config file with new Minimee cache path directory This allows our cache path to be dynamicly absolute based on the environment out code is in. $config[‘minimee_cache_path’] = $base_path . ‘/min’;35 ERIKREAGAN • EECI

BRANCHING Keeping things organized36 ERIKREAGAN • EECI

BRANCHING WORKFLOW Do what works best for you Just make sure you do it for a reason37 ERIKREAGAN • EECI

REMOTE BRANCHES • Destination for your repository / branch • “Origin” of your repository / branch • Server environment for your site • Other team member’s repository / branch38 ERIKREAGAN • EECI

TOPICAL BRANCHING • master • dev • feature/x • upgrade/y • bugﬁx/z39 ERIKREAGAN • EECI

“Its like not wearing a seatbelt in your car because you havent had an accident yet. Dont be silly, version your work.” Iain Urquhart / @iain40 ERIKREAGAN • EECI

GIT RESOURCES • Book: Pragmatic Version Control Using Git • peepcode.com/products/git • whygitisbetterthanx.com • github.com • More available with the presentation download41 ERIKREAGAN • EECI

ENVIRONMENTS42 ERIKREAGAN • EECI

AN ENVIRONMENT IS any server running an instance of your site43 ERIKREAGAN • EECI

COMMON ENVIRONMENTS • Production - the public-facing “live” site • Staging - typically used for a ﬁnal test • Development - shared team development • Local - each developer’s local instance44 ERIKREAGAN • EECI

SURVEY STATS45 ERIKREAGAN • EECI

Devs currently using a Production Environment100%46 ERIKREAGAN • EECI

Devs currently using a Staging Environment47 59% ERIKREAGAN • EECI

Devs currently using a Shared Dev Environment48 32% ERIKREAGAN • EECI

Devs currently using a Local Dev Environment49 77% ERIKREAGAN • EECI

Devs who keep using environments post-launch50 29% ERIKREAGAN • EECI

WHY DO YOU USE ENVIRONMENTS?51 ERIKREAGAN • EECI

“Local development is incredibly fast and you dont have to worry about setting up crazy conditionals and memeber preferences to hide what you are working on on the live site.”52 ERIKREAGAN • EECI

“Multiple environments allow us to build locally without aﬀecting others and preview new features to clients - without losing the ability to quickly apply updates to the current live site.”53 ERIKREAGAN • EECI

“Automated deployments and multiple environments are essential to any agile-oriented developer. They save time, reduce errors and streamline site maintenance.”54 ERIKREAGAN • EECI

GETTING SET UP What is potentially unique to each environment?55 ERIKREAGAN • EECI

GETTING SET UP What’s Unique? • Server paths • URL root • EE upload paths • Debug mode intentions • URI support (PATH_INFO) • Cache settings56 ERIKREAGAN • EECI

ROBUST CONFIG FILE Saves time and adds ﬂexibility57 ERIKREAGAN • EECI

GETTING SET UP What can be changed? ✓ Server paths ✓ URL root - EE upload paths ✓ Debug mode intentions ✓ URI support (PATH_INFO) ✓Cache settings58 ERIKREAGAN • EECI

GETTING SET UP Directory and ﬁle structure /config/ config.env.php config.master.php config.{ENV}.php /public_html/ /system/ /tpl/59 ERIKREAGAN • EECI

GETTING SET UP conﬁg.env.php sample if ( ! defined(ENV)) { switch ($_SERVER[HTTP_HOST]) { case focuslabllc.com : define(ENV, prod); define(ENV_FULL, Production); define(ENV_DEBUG, FALSE); break; case ohsnap.focuslabllc.com : define(ENV, stage); define(ENV_FULL, Staging); define(ENV_DEBUG, FALSE); break; default : define(ENV, local); define(ENV_FULL, Local); define(ENV_DEBUG, TRUE); break; } }60 ERIKREAGAN • EECI

GETTING SET UP conﬁg.dev.php sample <?php if ( ! defined(BASEPATH)) exit(No direct script access allowed); /** * Development config overrides & db credentials * * Our database credentials and any environment-specific overrides * * @package Focus Lab Master Config * @version 1.1 * @author Erik Reagan <erik@focuslabllc.com> */ $env_db[hostname] = localhost; $env_db[username] = ; $env_db[password] = ; $env_db[database] = ; $config[webmaster_email] = dev@focuslabllc.com; /* End of file config.dev.php */ /* Location: ./config/config.dev.php */61 ERIKREAGAN • EECI

GETTING SET UP conﬁg.master.php sample /** * Template settings * * Working locally we want to reference our template files. * In staging and production we do not use flat files * (for ever-so-slightly better performance) * This approach requires that we synchronize templates after * each deployment of template changes */$env_config[save_tmpl_files] = (ENV == prod) ? n : y;$env_config[tmpl_file_basepath] = $base_path . /../tpl/;$env_config[hidden_template_indicator] = _;62 ERIKREAGAN • EECI

GETTING SET UP conﬁg.master.php sample/** * Debugging settings * * These settings are helpful to have in one place * for debugging purposes */$env_config[is_system_on] = y;$env_config[allow_extensions] = y;$env_config[email_debug] = (ENV_DEBUG) ? y : n ;// Show template debugging if were not in production$env_config[template_debugging] = (ENV_DEBUG) ? y : n ;/** * Set debug to 2 if were in dev mode, otherwise just 1 * * 0: no PHP/SQL errors shown * 1: Errors shown to Super Admins * 2: Errors shown to everyone */$env_config[debug] = (ENV_DEBUG) ? 2 : 1 ;63 ERIKREAGAN • EECI

GETTING SET UP conﬁg.master.php sample /** * 3rd Party Add-on config items as needed */ $env_config[minimee_cache_path] = $base_path . /min; $env_config[minimee_cache_url] = $base_url . /min; $env_config[minimee_remote_mode] = auto; $env_config[minimee_debug] = n; // Disable minimee in dev but not in staging and production $env_config[minimee_disable] = (ENV == local) ? y : n ; // Greeny (auto-updating of upload directory paths) $env_config[greeny_enabled] = (ENV == prod) ? false :64 ERIKREAGAN • EECI

FOCUS LAB CONFIG SETUP github.com/focuslabllc/ee-master-conﬁg65 ERIKREAGAN • EECI

MULTI-ENVIRONMENT CHALLENGES You didn’t think it was that easy, did you?66 ERIKREAGAN • EECI

BACK TO THE SURVEY67 ERIKREAGAN • EECI

100%68 ERIKREAGAN • EECI

Keeping database changes synced across environments 100%68 ERIKREAGAN • EECI

72%69 ERIKREAGAN • EECI

Maintaining custom upload directory paths 72%69 ERIKREAGAN • EECI

Devs who say the headaches are worth the trouble 100% ERIKREAGAN • EECI70

DATABASE ISSUES • New custom ﬁelds alter the DB schema • Installing or updating add-ons can alter the DB schema • Updating EE can alter the DB schema71 ERIKREAGAN • EECI

DATABASE ISSUES • Custom upload directory paths are stored in the DB and cannot be dynamically altered • Relative upload directory paths work sometimes, but not with all add-ons • “Content” is very likely changing in the Production environment while you build and test in your other environments72 ERIKREAGAN • EECI

http://expressionengine.com/forums/viewthread/196480/73 ERIKREAGAN • EECI

QUICK TIPS • You need to understand EE’s database • Learn about 3rd party add-on’s DB tables • Establish a ruleset for your workﬂow • Understand that there will be exceptions74 ERIKREAGAN • EECI

Schema / Structureﬂows up stream75 ERIKREAGAN • EECI

Content ﬂowsdown stream76 ERIKREAGAN • EECI

FINAL NOTES • These practices make you a better developer • They help prepare you to work with a team • They help your team work more eﬃciently • You can provide a better service to your clients77 ERIKREAGAN • EECI

ERIKREAGAN Partner Focus Lab LLC FocusLabLLC78 ERIKREAGAN • EECI

Environments and Version Control in EE - The Why and How

by Erik Reagan on Oct 22, 2011

Accessibility

Categories

Tags

Upload Details

Usage Rights

Statistics

Environments and Version Control in EE - The Why and How — Presentation Transcript