Add Issue templates #117
Add Issue templates #117
Conversation
|
cc @e0ne |
|
As an improvement down the road we should IMO:
**lets first agree on the release process as proposed by this PR and then ill open an issue to automate it. |
.github/ISSUE_TEMPLATE/support.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| --- | |||
There was a problem hiding this comment.
It has been suggested by @e0ne that this may not be required as a bug template may be used instead.
Upside of having this is that this template will force the issuer to read the comment below before opening.
Im fine either way (remove/keep).
There was a problem hiding this comment.
I don't get this comment. is it on the "Support Request" template?
There was a problem hiding this comment.
yes, the comment is whether or not we need this template.
There was a problem hiding this comment.
I will remove it.
There was a problem hiding this comment.
This issue will make the process more complicated. IMO, feature requests and bug reports should be enough.
There was a problem hiding this comment.
right, we agree to remove it
|
|
||
| **Logs**: | ||
| - NicClusterPolicy CR spec and state: | ||
| - Output of: `kubectl -n mlnx-network-operator-resources get -A`: |
There was a problem hiding this comment.
I assume in the future we should change it to nvidia-network-operator-resources
There was a problem hiding this comment.
yes, perhaps we should do it sooner rather than later, you want me to push PR for it ?
| - Hardware configuration: | ||
| - OS (e.g: `cat /etc/os-release`): | ||
| - Kernel (e.g. `uname -a`): | ||
| - Others: |
There was a problem hiding this comment.
its under hardware configuration above
| --- | ||
| name: New Release | ||
| about: Propose a new release | ||
| title: Release vX.y.z |
There was a problem hiding this comment.
why the X.y.z and not x.y.z?
There was a problem hiding this comment.
Doesn't really matter, wanted to emphasise the "Major" version.
if i had a smaller "z" i would have put it.
I can make it x.y.z if it looks nasty.
| - [ ] Changelog for current release with: `New Features`, `Bug Fixes`, `Known Limitations` | ||
| - [ ] Release artifacts for current release | ||
| - [ ] Add link to https://mellanox.github.io/network-operator | ||
| - [ ] Update gh-pages branch |
There was a problem hiding this comment.
if we capture it in the issue we can remove the release.md in gh_pages
There was a problem hiding this comment.
yes i will remove it.
There was a problem hiding this comment.
will be removed in a separate PR as its a separte branch
| - [ ] Create release in github | ||
| - [ ] Changelog for current release with: `New Features`, `Bug Fixes`, `Known Limitations` | ||
| - [ ] Release artifacts for current release | ||
| - [ ] Add link to https://mellanox.github.io/network-operator |
There was a problem hiding this comment.
what it mean add link to https://mellanox.github.io/network-operator?
There was a problem hiding this comment.
no need on second thought, i will remove.
originally i wanted to reference our github pages from the github release. but thinking on it more, i dont think its needed.
There was a problem hiding this comment.
missed that sorry
| - [ ] Ensure Helm CI is passing on updated Chart. | ||
| - [ ] Tag release | ||
| - [ ] Create release in github | ||
| - [ ] Changelog for current release with: `New Features`, `Bug Fixes`, `Known Limitations` |
There was a problem hiding this comment.
where is the changelog is captured?
There was a problem hiding this comment.
it is captured in two places
- in the release issue
- in the github release itself (when you draft a release, you can fill info about the release.)
The description of the release will contain 3 sections : New features, bug fixes, known limitations.
i will explain it better here.
.github/ISSUE_TEMPLATE/support.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| --- | |||
There was a problem hiding this comment.
I don't get this comment. is it on the "Support Request" template?
| - [ ] Submit PR against `gh-pages` branch: | ||
| ``` | ||
| > git add <helm .tgz package> <release/index.yaml> <README.md> | ||
| > git commit --signoff -m "Release Network-Operator vX.y.z" |
adrianchiris
force-pushed
the
add-issue-templates
branch
from
ef34ed2
to
109d3af
Compare
This commit adds templates for possible issues that can be opened against Network Operator project - Bug report template: To be used when reporting a possible bug in network-operator - Enhancement template: To be used when requesting an enhancement/feature of network operator - Release template: To be used when creating a new release of network-operator. This includes a checklist of actions that should be done in order to release a new version of network-operator Signed-off-by: Adrian Chiris <adrianc@nvidia.com>
adrianchiris
force-pushed
the
add-issue-templates
branch
from
109d3af
to
0c2d6ee
Compare
This commit adds templates for possible issues
that can be opened against Network Operator project
a possible bug in network-operator
an enhancement/feature of network operator
of network-operator. This includes a checklist of actions
that should be done in order to release a new version
of network-operator
Signed-off-by: Adrian Chiris adrianc@nvidia.com