Skip to content

Commit

Permalink
Merge branch 'v2-dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
wuda-io committed Feb 2, 2024
2 parents e64cfa7 + c92fb1c commit ab5dfaa
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 73 deletions.
52 changes: 0 additions & 52 deletions .npmignore

This file was deleted.

1 change: 0 additions & 1 deletion CHANGELOG.md

This file was deleted.

35 changes: 22 additions & 13 deletions FOR_MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ This is the documentation that will be used by the maintainers. If you have idea

- [Labels](#labels)
- [Releasing a new version](#releasing-a-new-version)
- [Generating CHANGELOG.md](#generating-changelogmd)

## Labels
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
Expand All @@ -18,35 +17,45 @@ We have several labels that can be used to organize issues and PRs on this repo
## Releasing a new version
To fully release a new version, you need to have access to the @materializecss organization on the npmjs. Then, please follow the steps below:

1. In your local copy of Materialize, step into the dev Branch with `git checkout v2-dev` and pull the newest version
with `git pull origin v2-dev` to have the newest version. Run Tests and check if everything works.
1. In your local copy of Materialize, go into the dev Branch with `git checkout v2-dev` and pull the newest version
with `git pull origin v2-dev` to have the newest version from the server. Run Tests and check if everything works.

2. Make a new Release branch with `git checkout -b release-2.X.X-alpha`.
2. Create a new Release branch with `git checkout -b release-2.X.X-alpha`.
In case something happend or needs to be changed during the release it is better to keep the release on its own branch.

3. Run `npm run release -- --oldver=<current_version> --newver=<new_version>`
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
```npm run release -- --oldver=1.0.0 --newver=1.1.0```
```npm run release -- --oldver=1.0.0 --newver=1.1.0```

4. Verify that version is correctly replaced in:
4. Verify that the version is correctly replaced and files were generated in:
* package.json
* src\global.ts
* the docs* correctly show the new version `npm run dev`
* src/global.ts
* dist/js
* dist/css

5. Add Commit with message "chore: release 2.X.X-alpha". Then push to server.

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

7. Create a new (draft) release on GitHub
* Generate the Release notes automatically
* Upload the `materialize-v<new_vversion>.zip` from the bin-folder
* Click generate Release notes automatically and select previeous version (commit-lint of commit-messages is important here)
* Upload the `materialize-v<new_version>.zip` from the bin-folder
* Create a new tag together with the release

8. Merge the Pull Request after 3 days if there are no concerns and all checks passed.
8. Merge the Pull Request if all checks pass and there were no concerns.
* Set the draft release to public.

9. Publish the release on npmjs
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)
```git checkout main
git pull origin main
git checkout v2-dev
git pull origin v2-dev
git merge main
git push origin v2-dev
```

10. Publish the release on npmjs
* If you never logged in on npm, please do `npm login` first and enter your credentials
* Then run `npm publish` and follow the instructions there

10. Done! Yay new version 🥳
11. Done! Yay new version 🥳
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014-2019 Materialize
Copyright (c) 2014-2023 Materialize

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
19 changes: 13 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@materializecss/materialize",
"description": "Builds Materialize distribution packages",
"author": "Alvin Wang, Alan Chang",
"homepage": "https://materializecss.github.io/materialize/",
"description": "The responsive front-end library based on Material Design from Google.",
"author": "The Materialize Team",
"homepage": "https://materializeweb.com",
"version": "2.0.3",
"main": "dist/js/materialize.js",
"module": "src/index.ts",
Expand All @@ -17,6 +17,16 @@
"bugs": {
"url": "https://github.com/materializecss/materialize/issues"
},
"funding": [
{
"type": "github",
"url": "https://github.com/sponsors/materializecss"
},
{
"type": "opencollective",
"url": "https://opencollective.com/materialize"
}
],
"scripts": {
"dev": "grunt monitor",
"test": "grunt test",
Expand Down Expand Up @@ -74,10 +84,7 @@
},
"files": [
"dist",
"extras",
"src/**/*.ts",
"sass/**/*.scss",
"Gruntfile.js",
"LICENSE"
],
"config": {
Expand Down

0 comments on commit ab5dfaa

Please sign in to comment.