|
10 | 10 |
|
11 | 11 | ## Overview: |
12 | 12 |
|
13 | | -When doing a release in ml5, the following repositories need to also be updated: |
14 | | -1. ml5js/ml5-library |
15 | | -2. ml5js/ml5-examples |
16 | | -3. ml5js/ml5-website |
17 | | -4. ml5js/ml5-boilerplate |
18 | | - |
19 | | -The following **Parts 1 - 4** go through the process of making a new ml5 release. |
20 | | - |
21 | | -*** |
22 | | -### Part 1: `ml5-library`: |
23 | | -*** |
24 | | - |
25 | 13 | 1. Create a new branch from `development` with a name that matches the new release version: `v<#>.<#>.<#>` |
26 | 14 | ```sh |
27 | 15 | $ (development): git checkout -b v0.4.2 |
@@ -71,93 +59,4 @@ The following **Parts 1 - 4** go through the process of making a new ml5 release |
71 | 59 | $ (gh-pages): git merge release |
72 | 60 | $ (gh-pages): git push origin gh-pages |
73 | 61 | ``` |
74 | | -8. Make a new Github Release and Tag the release. Add release notes describing the changes for the new version. |
75 | | - |
76 | | -*** |
77 | | -### Part 2: `ml5-examples` |
78 | | - |
79 | | -In `ml5-examples` the **release** branch is our source of truth. Any fixes or new examples based on the **current ml5 version** will be directly merged into the **release** branch. |
80 | | - |
81 | | -The **development** branch is used in conjunction with the ml5-library **development** branch. What is different from the **release** branch is that all of the `index.html` files have their ml5 set to `localhost:8080` rather than the ml5 CDN. |
82 | | - |
83 | | -If we are doing a new release, this means that the new examples and features added to the **development** branch of `ml5-examples` needs to be merged with the **release** branch. |
84 | | - |
85 | | -The one thing to note is that the following steps are to handle merge conflicts that arise from running `npm run update:ml5-dev` to convert the ml5 script src. |
86 | | - |
87 | | -*** |
88 | | -1. Create a new branch from `release` with a name that matches the new release version: `v<#>.<#>.<#>` |
89 | | - ```sh |
90 | | - $ (development): git checkout -b v0.4.2 |
91 | | - ``` |
92 | | -2. Update the `version` in **package.json**. Update all of the `localhost` references to the ml5 CDN and create the new examples index. |
93 | | - ```sh |
94 | | - # Step 0: change the version in package.json from 0.4.1 to 0.4.2 |
95 | | - # Step 1: update all of the localhost references to from ml5 CDN to localhosy |
96 | | - $ (v0.4.2): npm run update:ml5-dev |
97 | | - $ (v0.4.2): git add . |
98 | | - ``` |
99 | | -3. Merge the changes from **release** into `v<#>.<#>.<#>` branch. |
100 | | - ```sh |
101 | | - $ (v0.4.2): git merge development |
102 | | - ``` |
103 | | -4. Make a **Pull Request** to merge `v<#>.<#>.<#>` to `release`. Wait for tests to pass. **Squash and merge**. |
104 | | - ```sh |
105 | | - # Once you've squashed and merged `v0.4.2` to `development`... |
106 | | - # Step 1: switch to your development branch and pull in those changes |
107 | | - $ (v0.4.2): git checkout release |
108 | | - $ (release): git fetch |
109 | | - $ (release): git pull |
110 | | - ``` |
111 | | -5. Add all of your changes to `gh-pages` to publish the latest docs |
112 | | - ```sh |
113 | | - $ (release): git checkout gh-pages |
114 | | - $ (gh-pages): git merge release |
115 | | - $ (gh-pages): git push origin gh-pages |
116 | | - ``` |
117 | | -6. Merge all the latest changes from **release** to **development** and revert all of the ml5 URLs in `development` back to `localhost`: |
118 | | - ```sh |
119 | | - $ (gh-pages): git checkout development |
120 | | - $ (development): npm run update:ml5 |
121 | | - $ (development): git add . |
122 | | - $ (development): git merge release |
123 | | - # merge |
124 | | - $ (development): npm run update:ml5-dev |
125 | | - $ (development): git add . |
126 | | - $ (development): git commit -m "sets ml5 to localhost" |
127 | | - $ (development): git push origin development |
128 | | - ``` |
129 | | -7. Make a new Github Release and Tag the release. Add release notes describing the changes for the new version. |
130 | | - |
131 | | -*** |
132 | | -### Part 3: `ml5-website` |
133 | | -*** |
134 | | -1. Create a new branch from `master` with a name that matches the new release version: `v<#>.<#>.<#>` |
135 | | - ```sh |
136 | | - $ (master): git checkout -b v0.4.2 |
137 | | - ``` |
138 | | -2. Update the **version reference** and the **date last updated** in the file `ml5-website/docs/index.md`. Add and commit and push your changes. |
139 | | - ```sh |
140 | | - $ (v0.4.2): git add . |
141 | | - $ (v0.4.2): git commit -m "bumps version" |
142 | | - $ (v0.4.2): git push origin v0.4.2 |
143 | | - ``` |
144 | | -3. On Github: Make a **Pull Request** to merge `v0.4.2` to `master`. Wait for tests to pass, then squash and merge. |
145 | | - |
146 | | - |
147 | | -*** |
148 | | -### Part 4: `ml5-boilerplate` |
149 | | -*** |
150 | | -1. Checkout `with-p5` update the version, add and commit your changes, and push up to the remote branch. |
151 | | - ```sh |
152 | | - # update the ml5 version to version 0.4.2 in index.html |
153 | | - $ (with-p5): git add . |
154 | | - $ (with-p5): git commit -m "bumps version" |
155 | | - $ (with-p5): git push origin with-p5 |
156 | | - ``` |
157 | | -2. Checkout `withoutp5` update the version, add and commit your changes, and push up to the remote branch. |
158 | | - ```sh |
159 | | - # update the ml5 version to version 0.4.2 in index.html |
160 | | - $ (without-p5): git add . |
161 | | - $ (without-p5): git commit -m "bumps version" |
162 | | - $ (without-p5): git push origin without-p5 |
163 | | - ``` |
| 62 | +8. Make a new Github Release and Tag the release. Add release notes describing the changes for the new version. |
0 commit comments