Skip to content

Commit 106ae9c

Browse files
author
TheSnoozer
committed
convert md issue templates into yml
1 parent ec18345 commit 106ae9c

File tree

7 files changed

+135
-68
lines changed

7 files changed

+135
-68
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug Report
2+
description: Create a bug report to help us fix an issue
3+
labels: [ "bug", "to-triage" ]
4+
assignees: [ ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please follow the instructions below.
10+
We will close issues that don't provide enough information.
11+
- type: textarea
12+
id: describe-the-bug
13+
attributes:
14+
label: Describe the bug (required)
15+
description: Please provide a brief summary of the issue and provide a summarised description in the title above.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: steps-to-reproduce
20+
attributes:
21+
label: Steps to Reproduce (required)
22+
description: |
23+
Please provide all the steps to experience the issue.
24+
value: |
25+
I run the plugin with ``mvn clean deploy`` VS ``mvn deploy:deploy``...
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: steps-to-reproduce-public-project
30+
attributes:
31+
label: Is there a (public) project where this issue can be reproduced? (optional)
32+
description: |
33+
You can use [this template](https://github.com/TheSnoozer/git-commit-id-debugging) to showcase your problem.
34+
validations:
35+
required: false
36+
- type: textarea
37+
id: environment
38+
attributes:
39+
label: Your Environment (optional)
40+
description: |
41+
Include as many relevant details about the environment you experienced the bug in.
42+
Are you running inside Windows Terminal, Powershell, Git Bash, /bin/bash, ...?
43+
On what Operating System you experience the bug (on Linux run ``lsb_release -a`` or ``cat /etc/*release*``)?
44+
validations:
45+
required: false
46+
- type: textarea
47+
id: context
48+
attributes:
49+
label: Context (optional)
50+
description: |
51+
Feel free to add any other context or screenshots about the bug.
52+
How are you affected? What is your goal? Anything else?
53+
validations:
54+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: [ "enhancement", "to-triage" ]
4+
assignees: [ ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please follow the instructions below.
10+
We will close issues that don't provide enough information.
11+
- type: textarea
12+
id: describe-the-idea
13+
attributes:
14+
label: Describe the idea (required)
15+
description: Please provide a brief summary of your idea and provide a summarised description in the title above.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected-behaviour
20+
attributes:
21+
label: Tell us about the expected behaviour (required)
22+
description: |
23+
If you're suggesting a change/improvement, tell us a bit more about the problem you attempt to solve and how you idea helps to solve it.
24+
Include a brief description of what you think should happen, maybe even how it should work and how you plan on using it.
25+
Ex. I'm always frustrated when [...]
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Context (optional)
32+
description: |
33+
Feel free to add any other context or screenshots about the feature.
34+
How are you affected? What is your goal? Anything else?
35+
validations:
36+
required: false
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: New release request
2+
description: Will be created by the author of the plugin, so not relevant for the public :-)
3+
labels: [ ]
4+
assignees: [ ]
5+
body:
6+
- type: textarea
7+
id: describe-the-release
8+
attributes:
9+
label: Describe the release details (required)
10+
description: |
11+
Just submit this as new issue...
12+
value: |
13+
This is the place holder to release the new 6.0.0 version.
14+
Previous releases can be found under https://repo1.maven.org/maven2/io/github/git-commit-id/git-commit-id-plugin-core/
15+
16+
Note that the current open tickets should be addressed, before performing a release.
17+
18+
# General scope of the new release:
19+
Fixed some minor things, added some minor features...(full list https://github.com/git-commit-id/git-commit-id-plugin-core//issues?q=milestone%3A6.0.0-rc.2).
20+
21+
# Release-Guide
22+
see http://central.sonatype.org/pages/ossrh-guide.html
23+
24+
- [ ] verify that `~/.m2/settings.xml` exists and contains username/password which is required as per https://central.sonatype.org/publish/publish-maven/#distribution-management-and-authentication
25+
- [ ] update dependencies `mvn versions:display-dependency-updates`
26+
- [ ] wait for github actions to pass
27+
- [ ] `mvn release:prepare`
28+
[INFO] Checking dependencies and plugins for snapshots ...
29+
What is the release version for "Git Commit Id Plugin Core"? (io.github.git-commit-id:git-commit-id-plugin-core) **6.0.0**: : [ENTER]
30+
What is SCM release tag or label for "Git Commit Id Plugin Core"? (io.github.git-commit-id:git-commit-id-plugin-core) git-commit-id-plugin-core-6.0.0: : **v6.0.0** [ENTER]
31+
What is the new development version for "Git Commit Id Plugin Core"? (io.github.git-commit-id:git-commit-id-plugin-core) **6.0.1-SNAPSHOT**: : [ENTER]
32+
- [ ] wait for github actions to pass
33+
- [ ] `mvn release:perform`
34+
- (or `mvn clean source:jar javadoc:jar deploy -Pgpg` from the git tag)
35+
- (or `mvn release:perform -Dresume=false`)
36+
- Note: If the uploading of the artifacts fails, ensure that a [`settings.xml`](https://github.com/git-commit-id/git-commit-id-maven-plugin/blob/master/.buildscript/settings.xml) exists under the local `.m2`-Folder
37+
- [ ] then go to https://s01.oss.sonatype.org/ log in there and go to the staging repositories, there will be the plugin, you have to first close and then release it if validation passed.
38+
- [ ] verify plugin is available on (might take some time) https://repo1.maven.org/maven2/io/github/git-commit-id/git-commit-id-plugin-core/
39+
- [ ] under [Milestones](https://github.com/git-commit-id/git-commit-id-plugin-core/milestones) close old milestone
40+
- [ ] under [Milestones](https://github.com/git-commit-id/git-commit-id-plugin-core/milestones) create new milestone for new version
41+
- [ ] under [Releases](https://github.com/git-commit-id/git-commit-id-plugin-core/releases) publish Release-Notes
42+
- [ ] update readme to point to the latest version available
43+
validations:
44+
required: true

0 commit comments

Comments
 (0)