forked from jgraph/mxgraph
-
Notifications
You must be signed in to change notification settings - Fork 199
Closed
Milestone
Description
We have solved the versioning issue, see #92. So we can release a version and publish the package on npm.
See also #41 (May 2021).
Documentation tasks
- Review milestone 0.1.0
- Configure GitHub auto-generated release notes: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes docs: configure the auto-generated release notes #142
- Review repository labels and the labels applied to merged Pull Requests. Labels are used to auto-generate the GH release notes
- Update the Changelog file. List fixes or add a link to the GH release. docs: update Changelog for version 0.1.0 #146
Content of the npm package
- Ensure that a README file is included. To avoid duplication with the main README, it can provide minimal information (description, how to install) and a link to the main README (https://github.com/maxGraph/maxGraph#readme) docs: include License and Readme files in the npm package #144
- Include the LICENSE files docs: include License and Readme files in the npm package #144
Publishing tasks
- Publish the npm package: @maxgraph/core@0.1.0. This will be probably done from a local dev machine. If so list the command that have been run in a comment to let other review. To be improve later by automating with GitHub Actions for instance. Publish steps: Prepare release 0.1.0 #141 (comment)
- Update the README docs: update README after the first public release #145
- add a npm status badge
- update the status paragraph and explain how to install the package