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
fix: bring more_examples up to date and minor formatting fixes in docs
1. Minor typography fixes in `CHANGELOG.md`, `CODE_OF_CONDUCT.md`, and `CONTRIBUTING.md`.
1. Switch from `app.run_server` to `app.run` in `more_examples/*/*.py`.
1. Update use of Dash Mantine Compnents in `more_examples/demo_stock_portfolio_dmc/app.py`.
1. Add `README.md` in `docs` to explain that this copy of the docs is no longer maintained.
1. Add `README.md` in `more_examples` to explain how to set up and run the examples.
1. Rename custom tooltip example to `app.py` for consistency.
@@ -7,25 +6,31 @@ If you have identified a bug or have an idea for a new feature, it's best to sta
7
6
8
7
If you have questions, please ask on the [Dash Community Forum](https://community.plotly.com/). rather than using GitHub issues.
9
8
10
-
11
-
### Developing in this repo
9
+
### Developing in This Repo
12
10
13
11
Make sure you have Dash installed with dev and testing extras:
12
+
14
13
```
15
14
pip install dash[dev,testing]
16
15
```
16
+
17
17
Build the component (from the root of this repo):
18
+
18
19
```
19
20
npm i
20
21
npm run build
21
22
```
23
+
22
24
Now install the component in development mode:
25
+
23
26
```
24
27
$ pip install -e .
25
28
```
29
+
26
30
In development mode, Python uses the files in this directory when you import the package. So you can write a testing app in another folder, and whenever you change some code and rebuild the component here it will update in your testing app.
27
31
28
32
### Versioning
33
+
29
34
We follow a strict versioning system aligned with the underlying Ag Grid version, but also reserving the
30
35
patch number for updates to the Dash grid.
31
36
@@ -39,31 +44,36 @@ As a user, you can always check the underlying Ag Grid version with `dash_ag_gri
39
44
40
45
For maintainers, when issuing new releases ensure that the version bump of Dash Ag Grid follows this convention. This can be verified after a build by using `npm run pre-flight-dag-version` or `python test_versioning.py`. This is validated during the `npm run dist`
41
46
42
-
### Create a production build
47
+
### Create a Production Build
43
48
44
49
Update the package version in `package.json` and `CHANGELOG.md` and ensure the changelog lists all the important updates. Then reinstall (so `package-lock.json` gets the new version) and rebuild:
50
+
45
51
```
46
52
npm i
47
53
npm run build
48
54
```
49
55
50
56
Commit this - either via a PR or directly to the main branch. Then you can create source and wheel distributions in the generated `dist/` folder, after emptying out any previous builds:
57
+
51
58
```
52
59
npm run dist
53
60
```
54
61
55
-
### Publish a new release
62
+
### Publish a New Release
63
+
56
64
A Github release with package build files is automatically generated when a new tag starting with `v*` is pushed.
57
65
58
66
Once a Github release is published, the build is re-generated and pushed to PyPi.
59
67
60
68
Create a git tag:
69
+
61
70
```
62
71
git tag -a 'v31.0,1' -m 'v31.0.1'
63
72
git push --tags
64
73
```
65
-
Wait for the "Generate release" CI job to complete, then check the releases tab to move the release from "Draft" to "Published". Make sure to copy in the Changelog!
66
74
67
-
When the release is published to Github, it's automatically pushed to PyPi as well. You're done 🎉
75
+
Wait for the "Generate release" CI job to complete, then check the releases tab to move the release from "Draft" to "Published". Make sure to copy in the Changelog.
76
+
77
+
When the release is published to Github, it's automatically pushed to PyPi as well.
68
78
69
79
Finally, announce the release in Slack, in both the `#dash-product` and `#community-ag-grid` channels. You're done!
0 commit comments