{"id":809,"date":"2024-05-17T14:36:32","date_gmt":"2024-05-17T18:36:32","guid":{"rendered":"https:\/\/sites.bu.edu\/marcom-team\/?page_id=809"},"modified":"2025-12-09T12:42:41","modified_gmt":"2025-12-09T17:42:41","slug":"deploys","status":"publish","type":"page","link":"https:\/\/sites.bu.edu\/marcom-team\/departments\/interactive-design\/role-specific-info\/info-for-developers\/deploys\/","title":{"rendered":"Running a Deploy"},"content":{"rendered":"

Deploys are when we need to push a new theme<\/em> or theme update<\/em> to the production (Live + Staging) server.<\/p>\n

Each environment and sandbox has its own manifest file. Production has a manifest file, called cms.ini<\/code>. www-test<\/code> has its own, and nm<\/code> has its own (nm.ini<\/code>).<\/p>\n

Each of these manifest.ini<\/code> files tells the environment which versions of each plugin\/theme\/WP-core to use. Every theme and plugin has its own entry in the manifest file. Each time a deploy is done, the deploy tool goes through the manifest file and essentially builds a .zip<\/code> file of all of the code. After the build is done, the tool sends that file to the environment, erases the environment, and then unzips the file. [This is why deploys take ~15 minutes.]<\/p>\n

<\/p>\n

Caution<\/strong><\/h2>\n

When building a manifest, check to see if a manifest is currently being built for the same environment. If so, the manifest may not be built correctly. Wait until that manifest is complete before building in the same environment. On the deploy screen, you can view the current status in the audit log to see if a manifest package is being built.<\/span><\/p>\n

The deploy tool can only run one deploy at a time\u2013 but if you queue up several, there won\u2019t be conflicts unless they\u2019re to the same sandbox\/env.<\/span><\/p>\n

Command Line Deploy<\/strong><\/h4>\n

Generally, there is no need to deploy from the command line anymore. The best way is to use the graphical deploy tool detailed below. If needed, IS&T has documentation for a <\/span>Command Line Deploy.<\/span><\/a><\/p>\n

<\/div>\n

<\/h3>
<\/p>\n

1. We make a change to the theme bu-bostonia<\/em> and commit it. To deploy, a developer has to go to the manifest file, and change the setting for bu-bostonia<\/em> to take the latest committed version. We make a build. (The build takes the newest<\/u> committed version of bu-bostonia and all of the current<\/u> versions of the rest of everything [themes,plugins,wp-core].) The deploy tool “unzips” it on production, and we’re done.<\/p>\n

2. Someone in IS&T makes a change to the bu-slideshow<\/em> plugin. They deploy it to staging and production. We start on a new theme and wonder why it’s different on NM. It’s because we haven’t pulled that change into the NM manifest. So, we take the NM manifest and tell it to use the newest<\/u> committed version of bu-slideshow<\/em> (and the current<\/u> versions of everything else). Again, it erases the environment and replaces it with what the manifest says. ***<\/strong> This is why if you haven’t had a developer add your theme to nm yet or have unsaved\/uncommitted changes on NM, they essentially disappear and you have to re-upload. ***<\/p>\n

<\/div>\n<\/div>\n\n

 <\/p>\n

How to Run a Deploy<\/h2>\n
\n

Note: These are instructions for running a “typical” deploy \u2014 that is, updating a theme in the production environment.<\/h4>\n
    \n
  1. Go to the deploy tool<\/a>.<\/li>\n
  2. Select build<\/strong>.
    \n\"\"
    \n<\/strong><\/li>\n
  3. Select Production<\/strong> as the Environment<\/em> and CMS<\/strong> as the Install<\/em>.
    \n\"\"<\/li>\n
  4. In the search field, type the theme or plugin you’d like to update, for example, r-gened<\/strong>.
    \n\"\"
    \n<\/strong><\/li>\n
  5. Double-click the theme name to turn it red<\/span>. This signifies that it is flagged for updating. Repeat the process to update additional themes\/plugins.
    \n\"\"<\/li>\n
  6. Scroll down, add a commit message along the lines of “updating r-gened,<\/em>” then click Validate<\/strong>.
    \n\"\"<\/li>\n
  7. You’ll wait for the validation to complete, usually ~30 seconds.
    \n\"\"<\/li>\n
  8. You’ll then get a Validation Successful<\/strong> message. Click the Build Updates <\/strong>button.
    \n\"\"<\/li>\n
  9. You’ll then wait for the build<\/strong> to process, ~10-15 minutes.
    \n\"\"<\/li>\n
  10. You’ll get a confirmation message that the build<\/strong> has completed. Click the Deploy<\/strong><\/span> this release link.
    \n\"\"<\/li>\n
  11. On this page, confirm that it is still set to Production<\/strong> as the Environment<\/em> and CMS<\/strong> as the Install<\/em>, then click Validate<\/strong>.
    \n\"\"<\/li>\n
  12. Wait again for the deploy<\/strong> to validate, ~30 seconds.
    \n\"\"<\/li>\n
  13. You’ll get a Validation Successful<\/strong> message. Click the Deploy Updates<\/strong> button.
    \n\"\"<\/li>\n
  14. Wait again for the deploy<\/strong> to complete, ~10-15 minutes.
    \n\"\"<\/li>\n
  15. You’ll get one final Awesome, it worked<\/strong> message. Your deploy is complete. Notify anyone who asked for a deploy that it has completed.
    \n\"\"<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"

    Deploys are when we need to push a new theme or theme update to the production (Live + Staging) server. Each environment and sandbox has its own manifest file. Production has a manifest file, called cms.ini. www-test has its own, and nm has its own (nm.ini). Each of these manifest.ini files tells the environment which […]<\/p>\n","protected":false},"author":12906,"featured_media":0,"parent":230,"menu_order":4,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/809"}],"collection":[{"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/users\/12906"}],"replies":[{"embeddable":true,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/comments?post=809"}],"version-history":[{"count":9,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/809\/revisions"}],"predecessor-version":[{"id":4175,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/809\/revisions\/4175"}],"up":[{"embeddable":true,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/230"}],"wp:attachment":[{"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/media?parent=809"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}