{"id":2304,"date":"2024-08-11T07:24:25","date_gmt":"2024-08-11T11:24:25","guid":{"rendered":"http:\/\/sites.bu.edu\/marcom-team\/?page_id=2304"},"modified":"2025-10-30T14:04:45","modified_gmt":"2025-10-30T18:04:45","slug":"releases","status":"publish","type":"page","link":"https:\/\/sites.bu.edu\/marcom-team\/departments\/interactive-design\/role-specific-info\/designers-developers\/pull-request-code-reviews\/releases\/","title":{"rendered":"Creating a Release"},"content":{"rendered":"<p>These steps assume you&#8217;re utilizing Tower.<\/p>\n<ol>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Make sure Git Flow is set up in Tower if that&#8217;s the app you use.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Stop all <code>grunt<\/code> processes you might have running to avoid compiling any further by pressing OPT+C in your code editor or OS&#8217; Terminal.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Make sure your local <code>develop<\/code> and <code>main<\/code> (or, if an outdated project: <code>master<\/code>) branch is up to date.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Select \u201c<strong>Start release<\/strong>\u201d from the Git Flow button in Tower, and name it with your new release number[<code>1.0.1.<\/code>, for example]. This creates a new &#8220;Release&#8221; tag branch.<\/span>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"2\"><span style=\"font-weight: 400;\">You should not have any changes you need to stash. If you do, commit them to develop first.<\/span><\/li>\n<\/ul>\n<\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Version bump your theme [see Versioning below if you don\u2019t know how] and update <code>CHANGELOG.md<\/code> with a brief list of changes. Copy that[you\u2019ll need it in a second].<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Commit to the release branch with the following message: \u201cVersion bump to [your new version number here; <code>#.#.#.<\/code>]\u201d<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Select \u201cFinish Release\u201d from the Git Flow button in Tower.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Paste in your changes from <code>CHANGELOG.md<\/code> into the Tag Message area in the Finish Release screen.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Both master\/main and develop will update. Push changes from both branches to Github.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Finally, in Github, create a new release using the same version number as the tag, and past in the changes from <code>CHANGELOG.md<\/code>.<\/span><\/li>\n<\/ol>\n<p><a href=\"https:\/\/mymedia.bu.edu\/media\/t\/1_yq21kout\" target=\"_blank\" rel=\"noopener noreferrer\" class=\"button-secondary\"><span style=\"font-weight: 400;\">See it in Action<\/span><\/a><\/p>\n<hr \/>\n<h2>Theme Versioning<\/h2>\n<ul>\n<li><a href=\"https:\/\/sites.bu.edu\/marcom-team\/departments\/interactive-design\/role-specific-info\/designers-developers\/git-versioning\/\">Review Git, Source &amp; Versioning<\/a><\/li>\n<\/ul>\n<h4><strong>How to version bump your theme<\/strong><\/h4>\n<p><span style=\"font-weight: 400;\">You can force your CSS and Javascript to refresh in your theme by updating your theme version. When you update your theme version, the framework uses a process called cache busting to make sure browsers know there is a new version of the CSS and Javascript available.<\/span><\/p>\n<h4><strong>Update the version number<\/strong><\/h4>\n<p><span style=\"font-weight: 400;\">You\u2019ll need to update the theme version in one place: <code>package.json<\/code>.<\/span><\/p>\n<ol>\n<li><span style=\"font-weight: 400;\">In your projects <code>package.json<\/code><\/span><span style=\"font-weight: 400;\">\u00a0file: increment the version number appropriately. <\/span><\/li>\n<li><span style=\"font-weight: 400;\">For this example, we\u2019ll assume we\u2019re making a minor update from the first big release of the theme. That means we\u2019ll be going from <code>1.0.0<\/code> to <code>1.0.1.<\/code> <\/span><\/li>\n<li><span style=\"font-weight: 400;\">Save <code>package.json<\/code> with the adjustment. In this case:\u00a0 <code>\"version\": \"1.0.1\",<\/code><\/span><\/li>\n<li>Regenerate Assets: In your code editor or OS terminal, type in the <code>grunt version<\/code> command and hit RETURN. Doing this will apply the new version number in <code>package.json<\/code> to your projects SCSS, Javascript, and <code>functions.php<\/code> file.<\/li>\n<li>Type in one final <code>grunt build<\/code> to compile everything and update the projects CSS files.<\/li>\n<li>Now that the new version number has been applied, update <code>changelog.md<\/code> with the version number[Example: <code>## 1.0.1<\/code>] and a few bullets in high-level detail (referencing issue numbers) what was coded or adjusted..<\/li>\n<\/ol>\n<p><i>And just like that: <\/i>you&#8217;ve updated a projects version number!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>These steps assume you&#8217;re utilizing Tower. Make sure Git Flow is set up in Tower if that&#8217;s the app you use. Stop all grunt processes you might have running to avoid compiling any further by pressing OPT+C in your code editor or OS&#8217; Terminal. Make sure your local develop and main (or, if an outdated [&hellip;]<\/p>\n","protected":false},"author":12906,"featured_media":0,"parent":663,"menu_order":2,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/2304"}],"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=2304"}],"version-history":[{"count":10,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/2304\/revisions"}],"predecessor-version":[{"id":4091,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/2304\/revisions\/4091"}],"up":[{"embeddable":true,"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/pages\/663"}],"wp:attachment":[{"href":"https:\/\/sites.bu.edu\/marcom-team\/wp-json\/wp\/v2\/media?parent=2304"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}