You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by GitBox <gi...@apache.org> on 2022/06/13 04:38:34 UTC
[GitHub] [echarts] Ovilia opened a new pull request, #17201: chore: update pr template to improve doc control
Ovilia opened a new pull request, #17201:
URL: https://github.com/apache/echarts/pull/17201
<!-- Please fill in the following information to help us review your PR more efficiently. -->
## Brief Information
This pull request is in the type of:
- [ ] bug fixing
- [ ] new feature
- [x] others
### What does this PR do?
<!-- USE ONE SENTENCE TO DESCRIBE WHAT THIS PR DOES. -->
Improve the PR template so that doc can always under control for each issue.
### Fixed issues
<!--
- #xxxx: ...
-->
## Details
### Before: What was the problem?
The release manager has to manually look through all pull requests in a certain release to check whether there should be document changes and whether they have been made into the `echarts-doc` repo. Sometimes it's hard for the release manager to know the detail of all PRs so it's not always an easy job to do.
### After: How is it fixed in this PR?
So I decide to improve the workflow so that:
- The author of a PR is mainly responsible to decide whether a PR requires document changes and whether a PR in `echarts-doc` repo has been made. This is done by editing the description of the PR.
- The reviews of the PR should check this info before merging.
The [Apache ECharts bot](https://github.com/apps/echarts-bot) is recently under debugging for this feature. It should add one of `PR: doc unchanged`, `PR: doc awaiting`, `PR: doc ready` to the PR based on the description. It will also give a warning if none of the three checks are made when a PR is opened and when a reviewer approves it.
I will also look into if we can made checking labels to be a prerequisite before merging.
## Misc
<!-- ADD RELATED ISSUE ID WHEN APPLICABLE -->
- [ ] The API has been changed (apache/echarts-doc#xxx).
- [ ] This PR depends on ZRender changes (ecomfe/zrender#xxx).
### Related test cases or examples to use the new APIs
N.A.
## Others
### Merging options
- [ ] Please squash the commits into a single one when merging.
### Other information
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] Ovilia merged pull request #17201: chore: update pr template to improve doc control
Posted by GitBox <gi...@apache.org>.
Ovilia merged PR #17201:
URL: https://github.com/apache/echarts/pull/17201
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] plainheart commented on pull request #17201: chore: update pr template to improve doc control
Posted by GitBox <gi...@apache.org>.
plainheart commented on PR #17201:
URL: https://github.com/apache/echarts/pull/17201#issuecomment-1153530328
Is it necessary to label `PR: doc unchanged` if one PR is unrelated to the documentation?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] Ovilia commented on pull request #17201: chore: update pr template to improve doc control
Posted by GitBox <gi...@apache.org>.
Ovilia commented on PR #17201:
URL: https://github.com/apache/echarts/pull/17201#issuecomment-1153581873
> Is it necessary to label `PR: doc unchanged` if one PR is unrelated to the documentation?
I'm thinking adding a "Check" before merging that checks if the PR contains one of the document related labels if it contains milestone information.
So if a PR should be presented in the changelog, it should have milestone information before being merged and should have a document related label.
On the other hand, if a PR should not be presented in the changelog (e.g. workflow changes), it doesn't need to have any document related labels.
I think this can help managing the document much better. Comments are welcomed and if we think this approach doesn't work well, we can adjust it in the future.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org