Skip to content

Commit

Permalink
Merge pull request #562 from materializecss/release-2.2.0
Browse files Browse the repository at this point in the history
Release 2.2.0
  • Loading branch information
wuda-io authored Dec 23, 2024
2 parents dda2c95 + 0f32ac5 commit b8ff154
Show file tree
Hide file tree
Showing 53 changed files with 3,513 additions and 35,359 deletions.
26 changes: 0 additions & 26 deletions .eslintrc

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
run: |
npm run release
- uses: actions/upload-artifact@v2
- uses: actions/upload-artifact@v4
with:
name: build
path: dist/
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ yarn-error.log*
# Dependency directories
node_modules/

dist
dist/**/*.*
!dist/css/*.css
!dist/css/*.css.map
Expand Down
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"printWidth": 100,
"parser": "flow",
"parser": "typescript",
"tabWidth": 2,
"useTabs": false,
"semi": true,
Expand Down
10 changes: 5 additions & 5 deletions FOR_MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ To fully release a new version, you need to have access to the @materializecss o
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. 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.
2. Create a new Release branch with `git checkout -b release-2.X.X`.
In case something happens 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```
3. Run `npm version <change-type>`
Where `<change-type> = patch, minor, major`.
[details](https://docs.npmjs.com/updating-your-published-package-version-number)

4. Verify that the version is correctly replaced and files were generated in:
* package.json
Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,31 +29,29 @@
</a>
</p>

## Quickstart
## Getting started
Read the [getting started guide](https://materializeweb.com/getting-started.html) for more information on how to use materialize.

- [Download the latest release](https://github.com/materializecss/materialize/releases/latest) of materialize directly from GitHub. ([Beta](https://github.com/materializecss/materialize/releases/))
- Clone the repo: `git clone https://github.com/materializecss/materialize.git`
- Include the files via [jsDelivr](https://www.jsdelivr.com/package/npm/@materializecss/materialize).
- Install with [npm](https://www.npmjs.com): `npm install @materializecss/materialize` (Beta: `npm install @materializecss/materialize@next`)

## Testing
To run tests locally you first have to build the files and then run the tests. This can be done with the command `npm test`;
To get more info and debug information you can do the following:
run `npx jasmine-browser-runner` then go to the url via browser `http://localhost:8888`. The tests will then run and show detailed feedback.

## Development
The documentation can be found at <https://materializeweb.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org) installed on your computer.

This is the core project with all the components. To see how they are used we recommend using an example project or go to the documentation.
Otherwise, if you want to develop the components itself, the dev process of this core-repo works like this:
```sh
npm install
npm run dev
```

### Running documentation locally
See [Materialize Docs Repo](https://github.com/materializecss/materialize-docs) to see Materialize in Action.

### Documentation for previous releases
### Releases
Previous releases are available [here](https://github.com/materializecss/materialize/releases).

## Release
If you want to release `materialize.css` or `materialize.js` from the latest commit, you can build the files with the following command after `npm install`. See `package.json` to check the current version like `1.0.0`.
```sh
npm run release -- --oldver=<current_version> --newver=<new_version>
Expand Down
4 changes: 2 additions & 2 deletions ci/compress.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const fs = require('fs');
const archiver = require('archiver');
import fs from 'fs';
import archiver from 'archiver';

const packageJson = JSON.parse(fs.readFileSync('./package.json').toString());

Expand Down
Loading

0 comments on commit b8ff154

Please sign in to comment.