This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-shared-resources.git
The following commit(s) were added to refs/heads/master by this push:
new 48a0710 Enable GitHub issues
48a0710 is described below
commit 48a07109ae408d662c19b061d3e48ac6920c3184
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Mon Jan 13 21:51:26 2025 +0100
Enable GitHub issues
---
.asf.yaml | 6 ++-
.asf.yaml => .github/ISSUE_TEMPLATE/BUG.yml | 58 +++++++++++++++----------
.asf.yaml => .github/ISSUE_TEMPLATE/FEATURE.yml | 45 ++++++++++---------
.asf.yaml => .github/ISSUE_TEMPLATE/config.yml | 40 ++++++++---------
.github/pull_request_template.md | 19 ++++++++
.github/workflows/pr-automation.yml | 29 +++++++++++++
README.md | 17 --------
7 files changed, 127 insertions(+), 87 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 823dade..4eaed4e 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -29,8 +29,12 @@ github:
rebase: true
autolink_jira:
- MSHARED
+ del_branch_on_merge: true
+ features:
+ issues: true
+
notifications:
commits: commits@maven.apache.org
issues: iss...@maven.apache.org
pullrequests: iss...@maven.apache.org
- jira_options: link label comment
+ jira_options: link label
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 823dade..d49e4ce 100644
--- a/.asf.yaml
+++ b/.github/ISSUE_TEMPLATE/BUG.yml
@@ -1,36 +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 Shared Resources"
- homepage: https://maven.apache.org/shared/maven-shared-resources/
- labels:
- - java
- - build-management
- - maven-shared
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MSHARED
-notifications:
- commits: commits@maven.apache.org
- issues: iss...@maven.apache.org
- pullrequests: iss...@maven.apache.org
- 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: massage
+ attributes:
+ label: Bug description
+ validations:
+ required: true
+
+
diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/FEATURE.yml
similarity index 60%
copy from .asf.yaml
copy to .github/ISSUE_TEMPLATE/FEATURE.yml
index 823dade..343183d 100644
--- a/.asf.yaml
+++ b/.github/ISSUE_TEMPLATE/FEATURE.yml
@@ -1,36 +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 Shared Resources"
- homepage: https://maven.apache.org/shared/maven-shared-resources/
- labels:
- - java
- - build-management
- - maven-shared
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MSHARED
-notifications:
- commits: commits@maven.apache.org
- issues: iss...@maven.apache.org
- pullrequests: iss...@maven.apache.org
- 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: massage
+ attributes:
+ label: New feature, improvement proposal
+ validations:
+ required: true
diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/config.yml
similarity index 58%
copy from .asf.yaml
copy to .github/ISSUE_TEMPLATE/config.yml
index 823dade..555bc41 100644
--- a/.asf.yaml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,36 +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 Shared Resources"
- homepage: https://maven.apache.org/shared/maven-shared-resources/
- labels:
- - java
- - build-management
- - maven-shared
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MSHARED
-notifications:
- commits: commits@maven.apache.org
- issues: iss...@maven.apache.org
- pullrequests: iss...@maven.apache.org
- 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/issues/?jql=project%20%3D%20MSHARED%20%20AND%20component%20%3D%20maven-shared-resources
+ about: Please search old JIRA issues
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..7c04bae
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,19 @@
+Following this checklist to help us incorporate your
+contribution quickly and easily:
+
+- [ ] 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.
+
+
+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
+please ask on the developers list.
+
+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 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/workflows/pr-automation.yml
b/.github/workflows/pr-automation.yml
new file mode 100644
index 0000000..e9d6698
--- /dev/null
+++ b/.github/workflows/pr-automation.yml
@@ -0,0 +1,29 @@
+# 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.
+
+name: PR Automation
+on:
+ pull_request_target:
+ types:
+ - closed
+ - unlabeled
+ - review_requested
+
+jobs:
+ pr-automation:
+ name: PR Automation
+ uses: apache/maven-gh-actions-shared/.github/workflows/pr-automation.yml@v4
diff --git a/README.md b/README.md
index e47d960..4c7fe6d 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,6 @@
Contributing to [Apache Maven Shared
Resources](https://maven.apache.org/shared/maven-shared-resources/)
======================
-[][jira]
[][license]
[](https://search.maven.org/artifact/org.apache.maven.shared/maven-shared-resources)
[](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/shared/maven-shared-resources/README.md)
@@ -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,25 +58,11 @@ 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.
-```
-[MSHARED-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
--------------------
@@ -90,7 +74,6 @@ Additional Resources
+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
+ #Maven IRC channel on freenode.org
-[jira]: https://issues.apache.org/jira/projects/MSHARED/
[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
