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-linkcheck-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new bd98d23 Enable GitHub Stuff (#7)
bd98d23 is described below
commit bd98d23e0f9cf3cb5552a05cc4f123d7d9fe0e09
Author: Matthias Bünger <[email protected]>
AuthorDate: Fri Apr 25 17:07:39 2025 +0200
Enable GitHub Stuff (#7)
---
.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 +++++++----------
.asf.yaml => .github/dependabot.yml | 37 ++++++----------
.github/pull_request_template.md | 23 ++++++++++
.github/release-drafter.yml | 18 ++++++++
.github/workflows/maven-verify.yml | 27 +++++++++++
.github/workflows/pr-automation.yml | 27 +++++++++++
.github/workflows/release-drafter.yml | 27 +++++++++++
.github/workflows/stale.yml | 28 ++++++++++++
README.md | 24 ++--------
pom.xml | 4 +-
13 files changed, 246 insertions(+), 118 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 950c91c..7f911ae 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -30,6 +30,9 @@ github:
rebase: true
autolink_jira:
- MLINKCHECK
+ 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 950c91c..699181f 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 Linkcheck Plugin"
- homepage: https://maven.apache.org/plugins/maven-linkcheck-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-linkcheck-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MLINKCHECK
-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 950c91c..ddfd1a4 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 Linkcheck Plugin"
- homepage: https://maven.apache.org/plugins/maven-linkcheck-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-linkcheck-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MLINKCHECK
-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 950c91c..a9fb835 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 Linkcheck Plugin"
- homepage: https://maven.apache.org/plugins/maven-linkcheck-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-linkcheck-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MLINKCHECK
-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/MLINKCHECK
+ about: Please search old JIRA issues
diff --git a/.asf.yaml b/.github/dependabot.yml
similarity index 59%
copy from .asf.yaml
copy to .github/dependabot.yml
index 950c91c..fd5b56e 100644
--- a/.asf.yaml
+++ b/.github/dependabot.yml
@@ -1,37 +1,26 @@
-#
+#
# 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 Linkcheck Plugin"
- homepage: https://maven.apache.org/plugins/maven-linkcheck-plugin/
- labels:
- - java
- - build-management
- - maven-plugins
- - maven-linkcheck-plugin
- - maven
- enabled_merge_buttons:
- squash: true
- merge: false
- rebase: true
- autolink_jira:
- - MLINKCHECK
-notifications:
- commits: [email protected]
- issues: [email protected]
- pullrequests: [email protected]
- jira_options: link label comment
+version: 2
+updates:
+- package-ecosystem: maven
+ directory: "/"
+ schedule:
+ interval: "daily"
+- package-ecosystem: "github-actions"
+ directory: "/"
+ schedule:
+ interval: "daily"
\ No newline at end of file
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..51e18bc
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,23 @@
+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.
+- [ ] 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
+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/release-drafter.yml b/.github/release-drafter.yml
new file mode 100644
index 0000000..387b9ca
--- /dev/null
+++ b/.github/release-drafter.yml
@@ -0,0 +1,18 @@
+# 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.
+
+_extends: maven-gh-actions-shared
diff --git a/.github/workflows/maven-verify.yml
b/.github/workflows/maven-verify.yml
new file mode 100644
index 0000000..932827c
--- /dev/null
+++ b/.github/workflows/maven-verify.yml
@@ -0,0 +1,27 @@
+# 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: Verify
+
+on:
+ push:
+ pull_request:
+
+jobs:
+ build:
+ name: Verify
+ uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v4
diff --git a/.github/workflows/pr-automation.yml
b/.github/workflows/pr-automation.yml
new file mode 100644
index 0000000..5307595
--- /dev/null
+++ b/.github/workflows/pr-automation.yml
@@ -0,0 +1,27 @@
+# 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
+
+jobs:
+ 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
new file mode 100644
index 0000000..96eaa60
--- /dev/null
+++ b/.github/workflows/release-drafter.yml
@@ -0,0 +1,27 @@
+# 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: Release Drafter
+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/stale.yml b/.github/workflows/stale.yml
new file mode 100644
index 0000000..776ebcd
--- /dev/null
+++ b/.github/workflows/stale.yml
@@ -0,0 +1,28 @@
+# 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: Stale
+
+on:
+ schedule:
+ - cron: '13 3 * * *'
+ issue_comment:
+ types: [ 'created' ]
+
+jobs:
+ stale:
+ uses: 'apache/maven-gh-actions-shared/.github/workflows/stale.yml@v4'
diff --git a/README.md b/README.md
index 7d3bc20..223e1b5 100644
--- a/README.md
+++ b/README.md
@@ -17,14 +17,13 @@
Contributing to [Apache Maven Linkcheck
Plugin](https://maven.apache.org/plugins/maven-linkcheck-plugin/)
======================
-[][jira]
[][license]
[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-linkcheck-plugin)
[][build]
[][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
@@ -33,7 +32,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.
@@ -59,37 +57,23 @@ 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.
-```
-[MLINKCHECK-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 Linkcheck 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)
-+ #Maven IRC channel on freenode.org
++ [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])
-[jira]: https://issues.apache.org/jira/projects/MLINKCHECK/
[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 7caf277..6f8665f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -47,8 +47,8 @@ under the License.
<tag>HEAD</tag>
</scm>
<issueManagement>
- <system>jira</system>
- <url>https://issues.apache.org/jira/browse/MLINKCHECK</url>
+ <system>GitHub Issues</system>
+ <url>https://github.com/apache/maven-linkcheck-plugin/issues</url>
</issueManagement>
<ciManagement>
<system>Jenkins</system>
