You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have several labels that can be used to organize issues and PRs on this repo and also to make the changelog generation easier. All the labels and their descriptions can be [read here](https://github.com/materializecss/materialize/issues/labels). Any other PRs that hasn't labeled with one of these will not be shown on the changelog. Please take a look at the table below
@@ -18,35 +17,45 @@ We have several labels that can be used to organize issues and PRs on this repo
18
17
## Releasing a new version
19
18
To fully release a new version, you need to have access to the @materializecss organization on the npmjs. Then, please follow the steps below:
20
19
21
-
1. In your local copy of Materialize, step into the dev Branch with `git checkout v2-dev` and pull the newest version
22
-
with `git pull origin v2-dev` to have the newest version. Run Tests and check if everything works.
20
+
1. In your local copy of Materialize, go into the dev Branch with `git checkout v2-dev` and pull the newest version
21
+
with `git pull origin v2-dev` to have the newest version from the server. Run Tests and check if everything works.
23
22
24
-
2.Make a new Release branch with `git checkout -b release-2.X.X-alpha`.
23
+
2.Create a new Release branch with `git checkout -b release-2.X.X-alpha`.
25
24
In case something happend or needs to be changed during the release it is better to keep the release on its own branch.
26
25
27
26
3. Run `npm run release -- --oldver=<current_version> --newver=<new_version>`
28
27
What this command does is that it will replace any occurrences of "<current_version>" with the "<new_version>". So for example, if the current release is `1.0.0`, and then the planned release is `1.1.0`, the command would be
29
-
```npm run release -- --oldver=1.0.0 --newver=1.1.0```
28
+
```npm run release -- --oldver=1.0.0 --newver=1.1.0```
30
29
31
-
4. Verify that version is correctly replaced in:
30
+
4. Verify that the version is correctly replaced and files were generated in:
32
31
* package.json
33
-
* src\global.ts
34
-
* the docs* correctly show the new version `npm run dev`
32
+
* src/global.ts
33
+
* dist/js
34
+
* dist/css
35
35
36
36
5. Add Commit with message "chore: release 2.X.X-alpha". Then push to server.
37
37
38
38
6. Create a Pull Request (PR) ([example](https://github.com/materializecss/materialize/pull/258) so that we can verify nothing goes wrong, address the feedback from the reviewers if there is any
39
39
40
40
7. Create a new (draft) release on GitHub
41
-
*Generate the Release notes automatically
42
-
* Upload the `materialize-v<new_vversion>.zip` from the bin-folder
41
+
*Click generate Release notes automatically and select previeous version (commit-lint of commit-messages is important here)
42
+
* Upload the `materialize-v<new_version>.zip` from the bin-folder
43
43
* Create a new tag together with the release
44
44
45
-
8. Merge the Pull Request after 3 days if there are no concerns and all checks passed.
45
+
8. Merge the Pull Request if all checks pass and there were no concerns.
46
46
* Set the draft release to public.
47
47
48
-
9. Publish the release on npmjs
48
+
9. Checkout and pull the new **main**-branch locally, merge it back into the **dev**-branch. Then push to server. [Explanation here](https://stackoverflow.com/a/72959052)
49
+
```git checkout main
50
+
git pull origin main
51
+
git checkout v2-dev
52
+
git pull origin v2-dev
53
+
git merge main
54
+
git push origin v2-dev
55
+
```
56
+
57
+
10. Publish the release on npmjs
49
58
* If you never logged in on npm, please do `npm login` first and enter your credentials
50
59
* Then run `npm publish` and follow the instructions there
0 commit comments