Skip to content

Commit e664284

Browse files
Enable GitHUb Issues
1 parent 7dee5ee commit e664284

File tree

9 files changed

+185
-29
lines changed

9 files changed

+185
-29
lines changed

.asf.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ github:
3030
rebase: true
3131
autolink_jira:
3232
- ARCHETYPE
33+
del_branch_on_merge: true
34+
features:
35+
issues: true
3336
notifications:
3437
3538

.github/ISSUE_TEMPLATE/BUG.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
19+
20+
name: Bug Report
21+
description: File a bug report
22+
labels: ["bug"]
23+
24+
body:
25+
- type: markdown
26+
attributes:
27+
value: |
28+
Thanks for taking the time to fill out this bug report.
29+
30+
Simple fixes in single PRs do not require issues.
31+
32+
**Do you use the latest project version?**
33+
34+
- type: input
35+
id: version
36+
attributes:
37+
label: Affected version
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: massage
43+
attributes:
44+
label: Bug description
45+
validations:
46+
required: true
47+
48+

.github/ISSUE_TEMPLATE/FEATURE.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
19+
20+
name: Feature request
21+
description: File a proposal for new feature, improvement
22+
labels: ["enhancement"]
23+
24+
body:
25+
- type: markdown
26+
attributes:
27+
value: |
28+
Thanks for taking the time to fill out this new feature, improvement proposal.
29+
30+
- type: textarea
31+
id: massage
32+
attributes:
33+
label: New feature, improvement proposal
34+
validations:
35+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
19+
20+
blank_issues_enabled: false
21+
22+
contact_links:
23+
24+
- name: Project Mailing Lists
25+
url: https://maven.apache.org/mailing-lists.html
26+
about: Please ask a question or discuss here
27+
28+
- name: Old JIRA Issues
29+
url: https://issues.apache.org/jira/projects/ARCHETYPE
30+
about: Please search old JIRA issues

.github/pull_request_template.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
Following this checklist to help us incorporate your
22
contribution quickly and easily:
33

4-
- [ ] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/ARCHETYPE) filed
5-
for the change (usually before you start working on it). Trivial changes like typos do not
6-
require a JIRA issue. Your pull request should address just this issue, without
7-
pulling in other changes.
8-
- [ ] Each commit in the pull request should have a meaningful subject line and body.
9-
- [ ] Format the pull request title like `[ARCHETYPE-XXX] SUMMARY`,
10-
where you replace `ARCHETYPE-XXX` and `SUMMARY` with the appropriate JIRA issue.
11-
- [ ] Also format the first line of the commit message like `[ARCHETYPE-XXX] SUMMARY`.
12-
Best practice is to use the JIRA issue title in both the pull request title and in the first line of the commit message.
4+
- [ ] Your pull request should address just one issue, without pulling in other changes.
135
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
14-
- [ ] Run `mvn clean verify` to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
6+
- [ ] Each commit in the pull request should have a meaningful subject line and body.
7+
Note that commits might be squashed by a maintainer on merge.
8+
- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
9+
This may not always be possible but is a best-practice.
10+
- [ ] Run `mvn clean verify` to make sure basic checks pass.
11+
A more thorough check will be performed on your pull request automatically.
12+
- [ ] You have run the integration tests successfully (`mvn -Prun-its clean verify`).
13+
1514

1615
If your pull request is about ~20 lines of code you don't need to sign an
1716
[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
@@ -22,5 +21,4 @@ the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LI
2221
you have to acknowledge this by using the following check-box.
2322

2423
- [ ] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
25-
2624
- [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).

.github/workflows/pr-automation.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: PR Automation
19+
on:
20+
pull_request_target:
21+
types:
22+
- closed
23+
- unlabeled
24+
- review_requested
25+
26+
jobs:
27+
pr-automation:
28+
name: PR Automation
29+
uses: apache/maven-gh-actions-shared/.github/workflows/pr-automation.yml@v4

.github/workflows/release-drafter.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
20+
name: Release Drafter
21+
on:
22+
push:
23+
branches:
24+
- master
25+
workflow_dispatch:
26+
27+
jobs:
28+
update_release_draft:
29+
uses: apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml@v4

README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
Contributing to [Apache Maven Archetype (Plugin)](https://maven.apache.org/archetype/)
1818
======================
1919

20-
[![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-ARCHETYPE.json)][jira]
2120
[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license]
2221
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-archetype-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.maven.plugins/maven-archetype-plugin)
2322
[![Reproducible Builds](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jvm-repo-rebuild/reproducible-central/master/content/org/apache/maven/archetype/badge.json)](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/archetype/README.md)
@@ -34,7 +33,6 @@ things.
3433
Getting Started
3534
---------------
3635

37-
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
3836
+ Make sure you have a [GitHub account](https://github.com/signup/free).
3937
+ If you're planning to implement a new feature, it makes sense to discuss your changes
4038
on the [dev list][ml-list] first.
@@ -60,25 +58,12 @@ There are some guidelines which will make applying PRs easier for us:
6058
+ Create minimal diffs - disable on save actions like reformat source code or organize imports.
6159
If you feel the source code should be reformatted, create a separate PR for this change.
6260
+ Check for unnecessary whitespace with `git diff --check` before committing.
63-
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
64-
```
65-
[ARCHETYPE-XXX] - Subject of the JIRA Ticket
66-
Optional supplemental description.
67-
```
6861
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
6962
+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken.
7063
+ Submit a pull request to the repository in the Apache organization.
71-
+ Update your JIRA ticket and include a link to the pull request in the ticket.
7264

7365
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla].
7466

75-
Making Trivial Changes
76-
----------------------
77-
78-
For changes of a trivial nature to comments and documentation, it is not always
79-
necessary to create a new ticket in JIRA. In this case, it is appropriate to
80-
start the first line of a commit with '(doc)' instead of a ticket number.
81-
8267
Additional Resources
8368
--------------------
8469

@@ -90,7 +75,6 @@ Additional Resources
9075
+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
9176
+ #Maven IRC channel on freenode.org
9277

93-
[jira]: https://issues.apache.org/jira/projects/ARCHETYPE/
9478
[license]: https://www.apache.org/licenses/LICENSE-2.0
9579
[ml-list]: https://maven.apache.org/mailing-lists.html
9680
[code-style]: https://maven.apache.org/developers/conventions/code.html

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@
5454
<url>https://github.com/apache/maven-archetype/tree/${project.scm.tag}</url>
5555
</scm>
5656
<issueManagement>
57-
<system>jira</system>
58-
<url>https://issues.apache.org/jira/browse/ARCHETYPE</url>
57+
<system>GitHub</system>
58+
<url>https://github.com/apache/maven-archetype/issues</url>
5959
</issueManagement>
6060
<ciManagement>
6161
<system>Jenkins</system>

0 commit comments

Comments
 (0)