Skip to content

Commit

Permalink
Merge pull request #404 from AnnMarieW/update-release
Browse files Browse the repository at this point in the history
update release process
  • Loading branch information
AnnMarieW authored Nov 18, 2024
2 parents 1ec9ee6 + b5f3e7a commit 54d7524
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 23 deletions.
25 changes: 18 additions & 7 deletions .github/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,39 @@
### Before release:

- [ ] Update Mantine dependency in `package.json`
- [ ] check for any added props or significant changes from the Mantine changelog. Open issues for any missing features.
- [ ] Update Mantine dependency for optional stylesheets in `styles.py`
- [ ] Update other dependencies - see notes section below for details
- [ ] Remove usage/demo apps used for testing
- [ ] `npm install` to install the new dependencies
- [ ] `npm run build` and push updated `package-lock.json`

- [ ] Review and update changelog - include PR numbers and contributor's GitHub username


### Release

On the Master branch:

1. Clean up dist - removes old and temp tarballs:
1. Clean up build and dist - removes old and temp tarballs:
```
rm -rf dist build
```

2. Run a new build
```
$ rm -rf dist
npm install
npm run build
```

2. Build source distribution. Note this will exclude metadata.json file which reduces the package size
Push updated `package-lock.json`

2. Build source distribution.
```
npm run dist
```
Confirm that this excluded metadata.json file which reduces the package size


3. Test your tarball by copying it into a new environment and installing it locally, for example:
```
pip install dash-mantine-components-0.14.5.tar.gz
Expand All @@ -33,21 +44,21 @@ pip install dash-mantine-components-0.14.5.tar.gz
4. Run the docs with the new release locally

4. Prepare release on the GitHub UI - For more information see [Managing Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
4. When in doubt, do an alpha release first
When in doubt, do an alpha release first

5. Publish on PyPI
```
$ twine upload dist/*
```

6. Publish on NPM

```
$ npm publish
```


### After release:
- [ ] check for any added props or significant changes from the Mantine changelog. Open issues for any missing features.
- [ ] Update dmc-docs. When the version changes, be sure to run `poetry update` and push the new `poetry.lock` file. The docs deploy automatically on Render
- [ ] Include new contributors in the docs
- [ ] Make announcement on Plotly forum and dmc Discord
Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ include requires-install.txt
include requires-dev.txt
include dash_mantine_components/package-info.json
include package.json
exclude dash_mantine_components/metadata.json
17 changes: 1 addition & 16 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 54d7524

Please sign in to comment.