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
Copy file name to clipboardExpand all lines: docs/about.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,6 +81,30 @@ mkdocs build
81
81
mkdocs gh-deploy
82
82
```
83
83
84
+
## Release on GitHub
85
+
86
+
This describes the release process for chartlets.
87
+
88
+
- Check issues in progress, close any open issues that have been fixed.
89
+
- Make sure that all unit tests pass and that test coverage is 100% (or as near to 100% as practicable).
90
+
- In `chartlets.py/chartlets/version.py`, `chartlets.js/packages/lib/package.json` and `chartlets.js/packages/demo/package.json` remove the .dev suffix from version name.
91
+
- Make sure `CHANGES.md` is complete in both `chartlets.js` and `chartlets.py`. Remove the suffix (in development) from the last version headline.
92
+
- Push changes to either main or a new maintenance branch and merge (see above).
93
+
- Await results from Github Action workflow.
94
+
- Go to `chartlets/releases` and press button `“Draft a new Release”`.
95
+
- Tag version is: `v${version}` (with a “v” prefix)
96
+
- Release title is: `${version}` (without a “v” prefix)
97
+
- Paste latest changes from `CHANGES.md` into field `“Describe this release”`
98
+
- Press `“Publish release”` button
99
+
- After the release on GitHub, the Github Actions CI would run to publish both
100
+
`chartlets.py` to `PyPi` and `chartlets.js` to `npm`.
101
+
- Create a new maintenance branch (see above)
102
+
- In `chartlets.py/chartlets/version.py`, `chartlets.js/packages/lib/package.json` and `chartlets.js/packages/demo/package.json` increase version number and append a .dev0 suffix to the version name so that it is still PEP-440 compatible.
103
+
- In `CHANGES.md` add a new version headline and attach (in development) to it.
104
+
- Push changes to either main or a new maintenance branch (see above).
105
+
- Activate new doc version on mkdocs
106
+
107
+
84
108
## License
85
109
86
110
Chartlets is open source made available under the terms and conditions of the
0 commit comments