-
Notifications
You must be signed in to change notification settings - Fork 233
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chore/documentation improvements (#413)
* chore: implement & document a better release process * chore: changelog generation * Add HISTORY.md * Fix jsdoc for debounce * Add .github_changelog_generator * chore: configure documentation in order to not require manual tweaks, update graph.config.js * docs: consolidate the release process * Change tooltip docs message
- Loading branch information
1 parent
b005d2d
commit 4907c77
Showing
8 changed files
with
553 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
unreleased=true | ||
future-release=2.6.0 | ||
since-tag=2.5.0 |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,34 @@ | ||
## Release Process | ||
# Release Process | ||
|
||
This is not yet a full automated process, so here are a few steps to get the thing properly released on github and publish under npm registry. | ||
Here are the steps to get the thing properly released on GitHub and published under the npm public registry. There's the need of some manual interventions throughout the release process. | ||
|
||
### Setup (serve a local version to run tests against it) | ||
## Requirements | ||
|
||
1. npm run dist:sandbox | ||
2. npm run start (server should keep running in the background as we're going to run | ||
cypress against it) | ||
- Make sure you're able to run `react-d3-graph` locally, follow the `Contributions` steps in the `README.md`. | ||
- Install the [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) gem locally. The distribution script will use it to automatically generate a changelog (if possible version >=1.15.2). | ||
- Verify the version: `github_changelog_generator -v` | ||
|
||
### Release steps | ||
|
||
1. Update versioning in package.json | ||
2. npm run dist | ||
3. npm run docs | ||
4. Small tweaks on documentation page (quicklinks) | ||
5. Replace current files in docs for the generated ones in gen-docs | ||
6. Generate CHANGELOG.md | ||
```bash | ||
github_changelog_generator since-tag=<PREVIOUS_RELEASED_VERSION> -u GITHUB_USERNAME | ||
1. Update versioning in `package.json`, `package-lock.json` and `.github_changelog_generator`. | ||
2. `npm run dist:sandbox` - generates new sandbox assets. | ||
3. `npm run start` - server should keep running in the background as we're going to run | ||
cypress against it. | ||
4. ```bash | ||
# https://github.com/github-changelog-generator/github-changelog-generator#github-token | ||
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»" | ||
export GITHUB_USERNAME="«your-github-user-name»" | ||
export VERSION_PREV=x.x.x | ||
export VERSION_NEW=x.x.x | ||
|
||
npm run dist | ||
``` | ||
7. git commit -m "Release x.x.x" | ||
8. Create release x.x.x in github | ||
9. git pull (origin master) | ||
10. npm publish | ||
|
||
Please fill in the `VERSION_*` env vars properly to ensure we link documentation during the build process. | ||
|
||
5. `git commit -am "Release x.x.x"`. | ||
6. Create the release x.x.x in GitHub. Go to [releases](https://github.com/danielcaldas/react-d3-graph/releases) and click `"Draft a new release"`. | ||
1. Pick a suitable title that highlights some of the most relevant changes. | ||
2. Copy & paste the output of the new CHANGELOG into the release notes. | ||
7. Once you're done on GitHub, go back to you terminal and type `git pull origin master` to pull the latest tag. | ||
8. `npm publish` (see [npm-publish docs](https://docs.npmjs.com/cli/v6/commands/npm-publish) for more details). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,21 @@ | ||
toc: | ||
- graph.config | ||
- Graph | ||
- Graph/renderer | ||
- Graph/builder | ||
- Graph/helper | ||
- Graph/collapse-helper | ||
- Node | ||
- Node/helper | ||
- Link | ||
- Link/helper | ||
- Link/const | ||
- Marker | ||
- Marker/helper | ||
- utils | ||
- name: Internal Documentation | ||
description: | | ||
This section of the documentation is mainly targeted for contributors | ||
working on react-d3-graph. If you're looking into making a change into the codebase | ||
this section could give you an organized overview on the library modules. | ||
children: | ||
- Graph/renderer | ||
- Graph/builder | ||
- Graph/helper | ||
- Graph/collapse-helper | ||
- Node | ||
- Node/helper | ||
- Link | ||
- Link/helper | ||
- Link/const | ||
- Marker | ||
- Marker/helper | ||
- utils |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters