This is an automated email from the ASF dual-hosted git repository.
mbuenger pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new e96fc5a5 Enable GH issues (#365)
e96fc5a5 is described below
commit e96fc5a5db9f05bf70735f4efc0f2370f5c37cbe
Author: Matthias Bünger <[email protected]>
AuthorDate: Fri Apr 25 17:08:45 2025 +0200
Enable GH issues (#365)
---
.asf.yaml | 3 ++
.asf.yaml => .github/ISSUE_TEMPLATE/BUG.yml | 59 +++++++++++++---------
.asf.yaml => .github/ISSUE_TEMPLATE/FEATURE.yml | 46 ++++++++---------
.asf.yaml => .github/ISSUE_TEMPLATE/config.yml | 41 +++++++--------
.github/pull_request_template.md | 27 ++++------
.github/release-drafter.yml | 1 -
.../{release-drafter.yml => pr-automation.yml} | 16 +++---
.github/workflows/release-drafter.yml | 2 +
.../workflows/{release-drafter.yml => stale.yml} | 17 ++++---
README.md | 23 ++-------
pom.xml | 4 +-
11 files changed, 115 insertions(+), 124 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 14c60fdd..9a934b81 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -30,6 +30,9 @@ github:
rebase: true
autolink_jira:
- MJAVADOC
+ del_branch_on_merge: true
+ features:
+ issues: true
notifications:
commits: [email protected]
issues: [email protected]
diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/BUG.yml
similarity index 53%
copy from .asf.yaml
copy to .github/ISSUE_TEMPLATE/BUG.yml
index 14c60fdd..699181ff 100644
--- a/.asf.yaml
+++ b/.github/ISSUE_TEMPLATE/BUG.yml
@@ -1,37 +1,48 @@
-#
+#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
-#
+#
# http://www.apache.org/licenses/LICENSE-2.0
-#
+#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-# see https://s.apache.org/asfyaml
-github:
- description: "Apache Maven Javadoc Plugin"
- homepage: https://maven.apache.org/plugins/maven-javadoc-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-javadoc-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MJAVADOC
-notifications:
- commits: [email protected]
- issues: [email protected]
- pullrequests: [email protected]
- jira_options: link label comment
+
+#
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report.
+
+ Simple fixes in single PRs do not require issues.
+
+ **Do you use the latest project version?**
+
+ - type: input
+ id: version
+ attributes:
+ label: Affected version
+ validations:
+ required: true
+
+ - type: textarea
+ id: message
+ attributes:
+ label: Bug description
+ validations:
+ required: true
+
+
diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/FEATURE.yml
similarity index 59%
copy from .asf.yaml
copy to .github/ISSUE_TEMPLATE/FEATURE.yml
index 14c60fdd..ddfd1a45 100644
--- a/.asf.yaml
+++ b/.github/ISSUE_TEMPLATE/FEATURE.yml
@@ -1,37 +1,35 @@
-#
+#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
-#
+#
# http://www.apache.org/licenses/LICENSE-2.0
-#
+#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-# see https://s.apache.org/asfyaml
-github:
- description: "Apache Maven Javadoc Plugin"
- homepage: https://maven.apache.org/plugins/maven-javadoc-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-javadoc-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MJAVADOC
-notifications:
- commits: [email protected]
- issues: [email protected]
- pullrequests: [email protected]
- jira_options: link label comment
+
+#
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+
+name: Feature request
+description: File a proposal for new feature, improvement
+labels: ["enhancement"]
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this new feature, improvement
proposal.
+
+ - type: textarea
+ id: message
+ attributes:
+ label: New feature, improvement proposal
+ validations:
+ required: true
diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/config.yml
similarity index 59%
copy from .asf.yaml
copy to .github/ISSUE_TEMPLATE/config.yml
index 14c60fdd..b417f135 100644
--- a/.asf.yaml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,37 +1,30 @@
-#
+#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
-#
+#
# http://www.apache.org/licenses/LICENSE-2.0
-#
+#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-# see https://s.apache.org/asfyaml
-github:
- description: "Apache Maven Javadoc Plugin"
- homepage: https://maven.apache.org/plugins/maven-javadoc-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-javadoc-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MJAVADOC
-notifications:
- commits: [email protected]
- issues: [email protected]
- pullrequests: [email protected]
- jira_options: link label comment
+
+#
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
+
+blank_issues_enabled: false
+
+contact_links:
+
+ - name: Project Mailing Lists
+ url: https://maven.apache.org/mailing-lists.html
+ about: Please ask a question or discuss here
+
+ - name: Old JIRA Issues
+ url: https://issues.apache.org/jira/projects/MJAVADOC
+ about: Please search old JIRA issues
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index df3f6943..51e18bc1 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,18 +1,15 @@
Following this checklist to help us incorporate your
contribution quickly and easily:
- - [ ] Make sure there is a [JIRA
issue](https://issues.apache.org/jira/browse/MJAVADOC) filed
- for the change (usually before you start working on it). Trivial
changes like typos do not
- require a JIRA issue. Your pull request should address just this
issue, without
- pulling in other changes.
- - [ ] Each commit in the pull request should have a meaningful subject line
and body.
- - [ ] Format the pull request title like `[MJAVADOC-XXX] - Fixes bug in
ApproximateQuantiles`,
- where you replace `MJAVADOC-XXX` with the appropriate JIRA issue. Best
practice
- is to use the JIRA issue title in the pull request title and in the
first line of the
- commit message.
- - [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- - [ ] Run `mvn clean verify -Prun-its` to make sure basic checks pass. A more
thorough check will
- be performed on your pull request automatically.
+- [ ] Your pull request should address just one issue, without pulling in
other changes.
+- [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
+- [ ] Each commit in the pull request should have a meaningful subject line
and body.
+ Note that commits might be squashed by a maintainer on merge.
+- [ ] Write unit tests that match behavioral changes, where the tests fail if
the changes to the runtime are not applied.
+ This may not always be possible but is a best-practice.
+- [ ] Run `mvn verify` to make sure basic checks pass.
+ A more thorough check will be performed on your pull request automatically.
+- [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
@@ -22,7 +19,5 @@ To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- - [ ] I hereby declare this contribution to be licensed under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
-
- - [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
-
+- [ ] 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)
+- [ ] In any other case, please file an [Apache Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf).
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
index 7da033ff..387b9ca2 100644
--- a/.github/release-drafter.yml
+++ b/.github/release-drafter.yml
@@ -16,4 +16,3 @@
# under the License.
_extends: maven-gh-actions-shared
-tag-template: maven-javadoc-plugin-$NEXT_MINOR_VERSION
diff --git a/.github/workflows/release-drafter.yml
b/.github/workflows/pr-automation.yml
similarity index 80%
copy from .github/workflows/release-drafter.yml
copy to .github/workflows/pr-automation.yml
index 1049eaa3..53075957 100644
--- a/.github/workflows/release-drafter.yml
+++ b/.github/workflows/pr-automation.yml
@@ -14,12 +14,14 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-
-name: Release Drafter
+
+name: PR Automation
on:
- push:
- branches:
- - master
+ pull_request_target:
+ types:
+ - closed
+
jobs:
- update_release_draft:
- uses:
apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml@v4
+ pr-automation:
+ name: PR Automation
+ uses: apache/maven-gh-actions-shared/.github/workflows/pr-automation.yml@v4
diff --git a/.github/workflows/release-drafter.yml
b/.github/workflows/release-drafter.yml
index 1049eaa3..96eaa60a 100644
--- a/.github/workflows/release-drafter.yml
+++ b/.github/workflows/release-drafter.yml
@@ -20,6 +20,8 @@ on:
push:
branches:
- master
+ workflow_dispatch:
+
jobs:
update_release_draft:
uses:
apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml@v4
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/stale.yml
similarity index 81%
copy from .github/workflows/release-drafter.yml
copy to .github/workflows/stale.yml
index 1049eaa3..5c1740fe 100644
--- a/.github/workflows/release-drafter.yml
+++ b/.github/workflows/stale.yml
@@ -14,12 +14,15 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-
-name: Release Drafter
+
+name: Stale
+
on:
- push:
- branches:
- - master
+ schedule:
+ - cron: '33 4 * * *'
+ issue_comment:
+ types: [ 'created' ]
+
jobs:
- update_release_draft:
- uses:
apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml@v4
+ stale:
+ uses: 'apache/maven-gh-actions-shared/.github/workflows/stale.yml@v4'
diff --git a/README.md b/README.md
index 6d986336..5d8dc1fa 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,6 @@
Contributing to [Apache Maven Javadoc
Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/)
======================
-[][jira]
[][license]
[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-javadoc-plugin)
[](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-javadoc-plugin/README.md)
@@ -25,7 +24,7 @@ Contributing to [Apache Maven Javadoc
Plugin](https://maven.apache.org/plugins/m
[][test-results]
-You have found a bug or you have an idea for a cool new feature? Contributing
+You have found a bug, or you have an idea for a cool new feature? Contributing
code is a great way to give something back to the open source community. Before
you dig right into the code, there are a few guidelines that we need
contributors to follow so that we can have a chance of keeping on top of
@@ -34,7 +33,6 @@ things.
Getting Started
---------------
-+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature, it makes sense to discuss
your changes
on the [dev list][ml-list] first.
@@ -60,37 +58,24 @@ There are some guidelines which will make applying PRs
easier for us:
+ Create minimal diffs - disable on save actions like reformat source code
or organize imports.
If you feel the source code should be reformatted, create a separate PR
for this change.
+ Check for unnecessary whitespace with `git diff --check` before committing.
-+ Make sure your commit messages are in the proper format. Your commit message
should contain the key of the JIRA issue.
-```
-[MJAVADOC-XXX] - Subject of the JIRA Ticket
- Optional supplemental description.
-```
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was
accidentally broken.
+ Submit a pull request to the repository in the Apache organization.
-+ Update your JIRA ticket and include a link to the pull request in the ticket.
If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement][cla].
-Making Trivial Changes
-----------------------
-
-For changes of a trivial nature to comments and documentation, it is not always
-necessary to create a new ticket in JIRA. In this case, it is appropriate to
-start the first line of a commit with '(doc)' instead of a ticket number.
-
Additional Resources
--------------------
+ [Contributing
patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
-+ [Apache Maven Javadoc JIRA project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request
documentation](https://help.github.com/send-pull-requests/)
-+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
++ [Apache Maven X Account](https://x.com/ASFMavenProject)
++ [Apache Maven Bluesky Account](https://bsky.app/profile/maven.apache.org)
++ [Apache Maven Mastodon
Account](https://mastodon.social/deck/@[email protected])
+ `#Maven channel` on [ASFs Slack](https://the-asf.slack.com)
-[jira]: https://issues.apache.org/jira/projects/MJAVADOC/
[license]: https://www.apache.org/licenses/LICENSE-2.0
[ml-list]: https://maven.apache.org/mailing-lists.html
[code-style]: https://maven.apache.org/developers/conventions/code.html
diff --git a/pom.xml b/pom.xml
index 86ea30b6..b0f371bb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -95,8 +95,8 @@ under the License.
<url>https://github.com/apache/maven-javadoc-plugin/tree/${project.scm.tag}</url>
</scm>
<issueManagement>
- <system>jira</system>
- <url>https://issues.apache.org/jira/browse/MJAVADOC</url>
+ <system>GitHub Issues</system>
+ <url>https://github.com/apache/maven-javadoc-plugin/issues</url>
</issueManagement>
<ciManagement>
<system>Jenkins</system>
