This is an automated email from the ASF dual-hosted git repository. olamy pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push: new d130acc3 Remove references to Jira (#812) d130acc3 is described below commit d130acc34ae5b780140af5fe5b968ea6fe2aa6ef Author: Olivier Lamy <ol...@apache.org> AuthorDate: Thu Jun 12 21:45:53 2025 +1000 Remove references to Jira (#812) * Remove Jira references --------- Signed-off-by: Olivier Lamy <ol...@apache.org> --- content/apt/developers/conventions/git.apt | 28 +++----- content/apt/developers/index.apt | 2 +- .../release/maven-project-release-procedure.apt | 16 ++--- .../apt/developers/release/parent-pom-release.apt | 2 +- content/apt/developers/retirement-plan-plugins.apt | 12 ++-- content/apt/guides/development/guide-helping.apt | 2 - .../guides/development/guide-maven-development.apt | 9 +-- .../development/guide-plugin-documentation.apt.vm | 4 +- content/apt/plugins/index.apt | 2 +- content/apt/plugins/localization.apt | 13 +--- content/apt/shared/index.apt | 2 +- content/apt/users/getting-help.apt | 32 +++------ content/markdown/community.md | 2 +- content/markdown/developers/conventions/jira.md | 79 ---------------------- content/markdown/faq-unoffical.md | 2 +- content/markdown/issue-management.md | 7 +- content/site.xml | 1 - 17 files changed, 41 insertions(+), 174 deletions(-) diff --git a/content/apt/developers/conventions/git.apt b/content/apt/developers/conventions/git.apt index fdf800d3..89a13b40 100644 --- a/content/apt/developers/conventions/git.apt +++ b/content/apt/developers/conventions/git.apt @@ -42,24 +42,17 @@ Maven Git Convention To contribute to a Maven component that is maintained in git, please follow these steps: - [[1]] create a JIRA for bug or improvement that you wish to work - on. The Maven project uses JIRA to organize and track our work, - and in particular to keep track of which changes are included in - which releases. - - [[2]] Make a fork of the official ASF clone from github.com. For + [[1]] Make a fork of the official ASF clone from github.com. For example, <<<https://github.com/apache/maven-scm>>>. - [[3]] Make a branch named after your JIRA ticket. This is not <required>, + [[2]] Make a branch named after your GitHub issue. This is not <required>, but it makes it easier for Maven committers to keep track of your contribution. - [[4]] Make your changes. As always, unit or integration tests make + [[3]] Make your changes. As always, unit or integration tests make it much easier for us to accept your changes. - [[5]] Make a pull request to pull your changes to the official clone. - Add a link to your pull request to the JIRA. Committers will take it - from here. + [[4]] Make a pull request to pull your changes to the official clone. ** For committers @@ -72,20 +65,18 @@ Maven Git Convention Commits should be focused on one issue at a time, because that makes it easier for others to review the commit. - A commit message should use this template: + While not mandatory, we will appreciate signed commits. + + If the changes is linked to an issue, the commit message should use this template: ------- -[ISSUE-1] <<Summary field from JIRA>> -Submitted by: <<Name of non-committer>> +Issue #1 <<Title from GitHub issue>> o Comments ------- Where: - * <<ISSUE-1>> can be omitted if there was no relevant JIRA issue, though you are strongly encouraged to create one for - significant changes. - * <<Submitted by>> only needs to be specified when a patch is being applied for a non-committer. * <<Comments>> some optional words about the solution. @@ -95,7 +86,7 @@ o Comments eg: ------- -[MNG-1456] Added the foo to the bar +Issue #123456 Add the foo to the bar Submitted by: Baz Bazman o Applied without change @@ -181,7 +172,6 @@ $ git checkout . --- git clone https://github.com/<youraccount>/maven-surefire.git -git remote add apache https://git-wip-us.apache.org/repos/asf/maven-surefire.git git remote add asfgithub https://github.com/apache/maven-surefire.git git config --add remote.asfgithub.fetch "+refs/pull/*/head:refs/remotes/asfgithub/pr/*" git fetch --all diff --git a/content/apt/developers/index.apt b/content/apt/developers/index.apt index ea98907c..c617ed02 100644 --- a/content/apt/developers/index.apt +++ b/content/apt/developers/index.apt @@ -81,7 +81,7 @@ Maven Developer Centre * {{{./conventions/code.html}Maven Code Style And Conventions}} - * Maven issue tracking conventions: {{{./conventions/jira.html}JIRA}} / {{{./conventions/github.html}GitHub Issues}} + * Maven issue tracking conventions: {{{./conventions/github.html}GitHub Issues}} * {{{./conventions/git.html}Maven Git Commit Conventions}} diff --git a/content/apt/developers/release/maven-project-release-procedure.apt b/content/apt/developers/release/maven-project-release-procedure.apt index 042a507b..bf5002e2 100644 --- a/content/apt/developers/release/maven-project-release-procedure.apt +++ b/content/apt/developers/release/maven-project-release-procedure.apt @@ -86,9 +86,7 @@ Performing a Maven Project Release * use release-drafter to help prepare release notes - in such case all PRs should a proper label - * copy paste release notes from JIRA - - * put link to release notes in JIRA + * copy paste release notes from GitHub [] @@ -130,10 +128,7 @@ Subject: [VOTE] Release Apache Maven XXX Plugin version Y.Z Hi, We solved N issues: -https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=XXXXXX&version=YYYYYYY&styleName=Text - -There are still a couple of issues left in JIRA: -https://issues.apache.org/jira/issues/?jql=project%20%3D%20XXXXXXXXXX%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20key%20DESC%2C%20priority%20DESC +https://github.com/apache/maven-compiler-plugin/issues?q=is%3Aissue%20state%3Aopen%20milestone%3A3.14.1 Changes since the last release: https://github.com/apache/<repository-name>/compare/<last-tag>...<current-tag> @@ -159,14 +154,11 @@ Vote open for at least 72 hours. ----- -** JIRA issues +** GitHub issues - To get the JIRA release notes link, browse to the plugin's or component's JIRA page, select the <Releases> link, pick a version, + To get the Github release notes link, browse to the GitHub repository, select the <Releases> link, pick a version, and use the link to <Release Notes> that is next to the version being released. - To get the list of issues left in JIRA, browse to the plugin's or component's JIRA page, and from the <Preset Filters> - on the right, use the link for <Outstanding> issues. - ** GitHub issues We link to the <GitHub milestone> for issues resolved in the release, and link to <GitHub issues> for issues that are still open: diff --git a/content/apt/developers/release/parent-pom-release.apt b/content/apt/developers/release/parent-pom-release.apt index 603c6c54..8526890b 100644 --- a/content/apt/developers/release/parent-pom-release.apt +++ b/content/apt/developers/release/parent-pom-release.apt @@ -60,7 +60,7 @@ mvn -f docs scm-publish:publish-scm * Call the vote - In the vote, additional to providing links to JIRA, the parent POMs should include a link to the Git changes since the + In the vote, additional to providing links to GitHub release, the parent POMs should include a link to the Git changes since the last release: ------- diff --git a/content/apt/developers/retirement-plan-plugins.apt b/content/apt/developers/retirement-plan-plugins.apt index ef8a6080..4216c3d4 100644 --- a/content/apt/developers/retirement-plan-plugins.apt +++ b/content/apt/developers/retirement-plan-plugins.apt @@ -100,14 +100,14 @@ I will continue with the steps required to retire this plugin. * Make the final release - [[1]] Create an issue in JIRA with the issue type "Task" and the summary + [[1]] Create an issue in GitHub with the issue type "Task" and the summary "Retire this plugin", and schedule it for the final release. If the plugin - includes a JIRA report in the generated site, you will need to close this + includes a GitHub report in the generated site, you will need to close this issue before you make the release. [[1]] Add the description "This is the final version of this plugin. It has been retired." - to the final version in JIRA. + to the final version in GitHub. [[1]] Add a prominent notice on the front page of the plugin's site, informing that the plugin is retired. Suggested text: @@ -131,10 +131,10 @@ but has moved to the <Organization> <Project> project. making sure that you follow the exceptions mentioned above regarding the site deployment. [[1]] When updating the plugins page, move Maven Foo Plugin to under the - "Retired" heading. Remove the SVN/Github and JIRA/Github Issues links and add + "Retired" heading. Remove the SVN/Github and Github Issues links and add the date of retirement. - [[1]] When updating the version in JIRA, do not add Y.Z+1 and make sure you + [[1]] When updating the version in GitHub, do not add Y.Z+1 and make sure you remove any future versions. This needs to be done by PMC members. * Clean up after the release @@ -149,7 +149,7 @@ but has moved to the <Organization> <Project> project. [[1]] When relevant update summary pages for {{{https://maven.apache.org/plugins/index.html}plugins}} or {{{https://maven.apache.org/shared/index.html}shared components}} - [[1]] Add " (RETIRED)" at the end of the project name in JIRA. This needs to be done by PMC members. + [[1]] Add " (RETIRED)" at the end of the project name in GitHub. This needs to be done by PMC members. [[1]] Put the JIRA project in read-only mode in case of standalone project (own Jira key): apply Maven Retired Project Permissions Scheme. (Requires JIRA admin karma: e.g. ask Brian Fox) diff --git a/content/apt/guides/development/guide-helping.apt b/content/apt/guides/development/guide-helping.apt index 4523708d..5eeb0f0f 100644 --- a/content/apt/guides/development/guide-helping.apt +++ b/content/apt/guides/development/guide-helping.apt @@ -86,8 +86,6 @@ Developers Conventions * {{{../../developers/conventions/code.html}Maven Code Style And Convention}} - * {{{../../developers/conventions/jira.html}Maven Jira Convention}} - * {{{../../developers/conventions/git.html}Maven Git Convention}} * {{{../../developers/release/index.html}Releasing a Maven project}} diff --git a/content/apt/guides/development/guide-maven-development.apt b/content/apt/guides/development/guide-maven-development.apt index c26325b7..ab5bf8c9 100644 --- a/content/apt/guides/development/guide-maven-development.apt +++ b/content/apt/guides/development/guide-maven-development.apt @@ -38,8 +38,7 @@ Developing Maven * Finding some work to do - First of all you need something to work on! Issues can be found in - {{{/issue-management.html}several JIRA projects}}. + First of all you need something to work on! Issues can be found on each GitHub repo issues. Another good place to look for work is the {{{https://s.apache.org/up-for-grabs_maven} Up for grabs}} list. This list contains relatively simple issues that can be worked on without a lot of prerequisite knowledge. @@ -85,9 +84,7 @@ Developing Maven * Create your branch from <<<master>>>, not from a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable to the development head. - * If this was a new piece of work without a JIRA issue, create a JIRA issue for it now. - - * Name the branch after the issue number; the branch name would start with <<<\<jira-project-id>-<ticket-id\>>>>. + * Name the branch after the issue number; the branch name would start with <<<\-<ticket-id\>>>>. * Push your branch with the commit(s) to your fork. @@ -199,6 +196,4 @@ Developing Maven * {{{../../developers/conventions/code.html}Maven Code Style And Code Convention}} - * {{{../../developers/conventions/jira.html}Maven JIRA Convention}} - [] diff --git a/content/apt/guides/development/guide-plugin-documentation.apt.vm b/content/apt/guides/development/guide-plugin-documentation.apt.vm index c37f0c4c..1927d5cb 100644 --- a/content/apt/guides/development/guide-plugin-documentation.apt.vm +++ b/content/apt/guides/development/guide-plugin-documentation.apt.vm @@ -79,8 +79,8 @@ mvn site <project> [...] <issueManagement> - <system>jira</system> - <url>http://jira.someproject.org</url> + <system>github</system> + <url>http://gitub.com/apache/foo/issues</url> </issueManagement> [...] </project> diff --git a/content/apt/plugins/index.apt b/content/apt/plugins/index.apt index 3c29bafd..33d5e604 100644 --- a/content/apt/plugins/index.apt +++ b/content/apt/plugins/index.apt @@ -127,7 +127,7 @@ Available Plugins *--------------------------------------------------------------+------------+--------------+------------+------------------+------------------------+--------------------+ | {{{/plugins/maven-pmd-plugin/} <<<pmd>>>}} | B+R | 3.26.0 | 2024-10-25 | Generate a PMD/CPD report. | {{{https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git}Git}} / {{{https://github.com/apache/maven-pmd-plugin/}GitHub}} | {{{https://github.com/apache/maven-pmd-plugin/issues}GitHub Issues}} *--------------------------------------------------------------+------------+--------------+------------+------------------+------------------------+--------------------+ -| {{{/plugin-tools/maven-plugin-report-plugin/} <<<plugin-report>>>}} | R | 3.15.1 | 2024-10-22 | Create a plugin documentation for any mojos found in the source tree. | {{{https://gitbox.apache.org/repos/asf/maven-plugin-tools.git}Git}} / {{{https://github.com/apache/maven-plugin-tools/}GitHub}} | {{{https://issues.apache.org/jira/browse/MPLUGIN}Jira MPLUGIN}} +| {{{/plugin-tools/maven-plugin-report-plugin/} <<<plugin-report>>>}} | R | 3.15.1 | 2024-10-22 | Create a plugin documentation for any mojos found in the source tree. | {{{https://gitbox.apache.org/repos/asf/maven-plugin-tools.git}Git}} / {{{https://github.com/apache/maven-plugin-tools/}GitHub}} | {{{https://github.com/apache/maven-plugin-tools/issues}GitHub Issues}} *--------------------------------------------------------------+------------+--------------+------------+------------------+------------------------+--------------------+ | {{{/plugins/maven-project-info-reports-plugin/} <<<project-info-reports>>>}} | R | 3.9.0 | 2025-02-23 | Generate standard project reports. | {{{https://gitbox.apache.org/repos/asf/maven-project-info-reports-plugin.git}Git}} / {{{https://github.com/apache/maven-project-info-reports-plugin/}GitHub}} | {{{https://github.com/apache/maven-project-info-reports-plugin/issues}GitHub Issues}} *--------------------------------------------------------------+------------+--------------+------------+------------------+------------------------+--------------------+ diff --git a/content/apt/plugins/localization.apt b/content/apt/plugins/localization.apt index e3e0ae94..8ca8bfe2 100644 --- a/content/apt/plugins/localization.apt +++ b/content/apt/plugins/localization.apt @@ -125,21 +125,10 @@ Localization of Plugins * Run "mvn site" on that project to test it. - * When you are happy with your translation, create an issue in JIRA for the + * When you are happy with your translation, create a Pull Request for the plugin in question, with a description like this: "Add Spanish translation". Take note of the issue number. - * Create a patch file that contains your new translation. Use the issue number - when you name the file: - ------- -svn diff > MYISSUE-123.patch ------- - - * Attach your patch file to the issue in JIRA. - - [] - * Tools diff --git a/content/apt/shared/index.apt b/content/apt/shared/index.apt index d127aee1..77eb7209 100644 --- a/content/apt/shared/index.apt +++ b/content/apt/shared/index.apt @@ -77,7 +77,7 @@ Shared Components *----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ | {{{/shared/maven-verifier/} <<<maven-verifier>>>}} | 2.0.0-M1 | 2022-09-22 | Used to run Maven builds as part of tests. | {{{https://gitbox.apache.org/repos/asf/maven-verifier.git}Git}} / {{{https://github.com/apache/maven-verifier/}GitHub}} | {{{https://github.com/apache/maven-verifier/issues}GitHub Issues}} *----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ -| {{{/scm/} <<<maven-scm>>>}} | 2.1.0 | 2024-04-11 | Generic API to SCM systems. | {{{https://gitbox.apache.org/repos/asf/maven-scm.git}Git}} / {{{https://github.com/apache/maven-scm/}GitHub}} | {{{https://issues.apache.org/jira/browse/SCM}JIRA}} +| {{{/scm/} <<<maven-scm>>>}} | 2.1.0 | 2024-04-11 | Generic API to SCM systems. | {{{https://gitbox.apache.org/repos/asf/maven-scm.git}Git}} / {{{https://github.com/apache/maven-scm/}GitHub}} | {{{https://github.com/apache/maven-scm/issues}GitHub Issues}} *----------------------------------------------------------------------------+--------------+-------------------+------------------+------------------------+---------------------+ diff --git a/content/apt/users/getting-help.apt b/content/apt/users/getting-help.apt index f0a5bdc1..fddf9aa8 100644 --- a/content/apt/users/getting-help.apt +++ b/content/apt/users/getting-help.apt @@ -67,39 +67,20 @@ Getting Help If it turns out that there is indeed something wrong with Maven or one of the plugins, you should report it to the issue management system. - Please check the project's documentation, if it is still used JIRA (which requires an account - see below) as its issue management system or if it is already migrated to GitHub issues. + All projects (Apache Maven core, Apache Maven plugins, sub components) have been migrated to use GitHub issues. You don't need create an issue only to ask us something - in such case please first ask on {{{https://maven.apache.org/mailing-lists.html}users-list}} -**Request new JIRA account - - Requesting for JIRA account is preferred if you plan to contribute to project by coding or testing by longer time. - - This is so that we can communicate with you while we work together on the issue. - - * please use your real name and surname if possible in public name field - - * links to your public projects, social or professional profile can be appreciated - - * you can also tell us a little about yourself and what you intend to use this account for - - [] - - Such information is useful to verify that account is requested for real user not a bot. - - Go to the {{{https://selfserve.apache.org/jira-account.html?project=maven}Request a JIRA account}} - to request for a new account if you don't already have one. - **Where? If the problem is in one of the plugins, check the site of that plugin to - get the correct link. Each plugin has its own section in JIRA, so using the + get the correct link. Each plugin has its own GitHub repository, so using the correct link is important. Click on <Project Information> and then - <Issue Management>. On that page you will find the correct link. + <Source Code Management>. On that page you will find the correct link. - If the problem is in Maven itself you can find the appropriate link on the - {{{https://maven.apache.org/issue-management.html}issue management}} page. + If the problem is in Maven itself you can find the appropriate link to GitHub repository on the + {{{https://maven.apache.org/scm.html}scm}} page. **How? @@ -122,6 +103,9 @@ Getting Help patch for an issue please read the {{{../guides/development/guide-maven-development.html}Maven Developer Guide}} first. + If you have been able to figure out the changes needed for your problem or enhancement request, you can directly + create a Pull Request against the GitHub repository. + * References * {{{http://www.catb.org/~esr/faqs/smart-questions.html}How To Ask Questions The Smart Way}} (Note: HTTP only!) diff --git a/content/markdown/community.md b/content/markdown/community.md index bf9af440..9d7351be 100644 --- a/content/markdown/community.md +++ b/content/markdown/community.md @@ -40,7 +40,7 @@ explained in a better way or you simply miss things do not hesitate to contact the maven community via the users mailing list and tell us about it. -### Help Log Defects in JIRA +### Help Log Defects in GitHub Just as any other healthy project requires a quick turn-around on defects, and a transparent method of users to have their wishes heard, diff --git a/content/markdown/developers/conventions/jira.md b/content/markdown/developers/conventions/jira.md deleted file mode 100644 index c7cee7b8..00000000 --- a/content/markdown/developers/conventions/jira.md +++ /dev/null @@ -1,79 +0,0 @@ -# Maven JIRA Conventions - -<!-- -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. ---> - -This document describes how Maven developers should use JIRA, our issue management system. - -## When To Create a JIRA Issue? - -This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR). - -- **Minor changes** such as code reformatting, documentation fixes, etc. that aren't going to impact other users - can be committed without a JIRA issue. - -- **Larger changes** such as bug fixes, API changes, significant refactoring, new classes, and pretty much any change - of more than 100 lines, should have JIRA tickets. - -Creating a JIRA issue and referring it in the commit comments simplifies tracking the changes that happen in a release, -using JIRA automatic release notes creation. - -## How To Use Issue Details? - -This section presents some conventions about the issue fields. - -### Priority - -Committers have the responsibility to realign priority by editing the issue. - -*Reasoning*: having a correct release note - -### Assignee - -Committers can assign an issue to a specific committer that person seems to -be well placed to address it. - -### Component/s - -Committers have the responsibility to specify the correct component by editing the issue. - -*Reasoning*: having a correct release note. - -### Affects Version/s - -By default, the Maven team considers that an issue which affects a given version also affects preceding versions. For example, an issue -that affects Maven 3.6.3 also affects 3.6.0, 3.6.1, 3.6.2. -If it is a regression, the committers should specify the affected versions. - -*Reasoning*: having a correct release note. - -### Fix Version/s - -Update to correct version after merging to master. - -### Time Tracking - -The Maven team doesn't use this. Committers can if it helps them. - -## Further Links - -- [JIRA Documentation](https://confluence.atlassian.com/jira064/jira-documentation-720411693.html) -- [What is an Issue?](https://confluence.atlassian.com/jira064/what-is-an-issue-720416138.html) -- [What is a project?](https://confluence.atlassian.com/jira064/what-is-a-project-720416135.html) - diff --git a/content/markdown/faq-unoffical.md b/content/markdown/faq-unoffical.md index a8aebf5e..1a388d58 100644 --- a/content/markdown/faq-unoffical.md +++ b/content/markdown/faq-unoffical.md @@ -122,7 +122,7 @@ To resolve this error: plug-ins. If the error persists, browse [archived discussions](http://www.mail-archive.com/users@maven.apache.org/), post to the -Maven user list, or log a [ticket](http://jira.codehaus.org/browse/MNG) describing your problem, if you think it is a +Maven user list, or log a [ticket](https://github.com/apache/maven/issues) describing your problem, if you think it is a bug. Tickets may also be issued for feature enhancement requests, and other tasks. ### How do I include/exclude the other modules in the navigation menu in the parent site? diff --git a/content/markdown/issue-management.md b/content/markdown/issue-management.md index 28d9d681..3bb0e9ad 100644 --- a/content/markdown/issue-management.md +++ b/content/markdown/issue-management.md @@ -19,17 +19,16 @@ specific language governing permissions and limitations under the License. --> -Maven projects use [Jira](https://www.atlassian.com/software/jira) as issue tracking and project management application. +Maven projects use GitHub issues as issue tracking and project management application. ## Issue Management -Maven is composed of nearly [100 parts](/scm.html#Maven_Sources_Overview), each one having its own Jira project or component: -**see the [Maven Jira issues overview](https://cwiki.apache.org/confluence/display/MAVEN/Maven+JIRA+issues+overview) to get a summary of open issues**. +Maven is composed of nearly [100 parts](/scm.html#Maven_Sources_Overview), each one having its own GitHub repository. Issues, bugs, and feature requests should be submitted to the following issue management systems depending on which component is involved: -* Maven "core": <https://issues.apache.org/jira/browse/MNG> +* Maven "core": <https://github.com/apache/maven/issues> * Maven Website: <https://github.com/apache/maven-site/issues> diff --git a/content/site.xml b/content/site.xml index 83c02ca5..0522b2c6 100644 --- a/content/site.xml +++ b/content/site.xml @@ -172,7 +172,6 @@ under the License. <item name="Maven Developer Centre" href="/developers/index.html" collapse="true"> <item name="Guide to Helping with Maven" href="/guides/development/guide-helping.html"/> <item name="Code Style and Conventions" href="/developers/conventions/code.html"/> - <item name="JIRA Convention" href="/developers/conventions/jira.html"/> <item name="Git Convention" href="/developers/conventions/git.html"/> <item name="GitHub Convention" href="/developers/conventions/github.html"/> <item name="Developing Maven" href="/guides/development/guide-maven-development.html" collapse="true">