Status: Completed



Guide: How To enable GitHub Issues


Phase 1: enable GitHub Issues and stop new issues in Jira

At all time update the progress tracking table below.

Step 1: Add a GH release for last release done with Jira

If the project has not yet defined a release, create one from last to second last tag before merge = what is supposed to correspond to lat release done with Jira. If you already merged a PR to enable Github issues, define one and then run the "release-drafter" action after it.

Example: https://github.com/apache/maven-site-plugin/releases 

Step 2: Create GH milestone(s) for future releases

We have to have one open milestone for master branch.

If the repository has an active developed 3.x release-branch, we have to have one for this too and add the branch name in the description of each milestone (for example: "branch: main")

Examples: https://github.com/apache/maven-site-plugin/milestones

Step 3: Create a PR based on/for "master" branch

Create a PR for master branch and update/add the following files  (depending on what is already existing in the repository)

  • Inside .github folder
    • Add / update "pull_request_template.md" to a version with only run verify, but not clean goal
    • Add / Update "release-drafter.yml" and remove "tag-template" line (if it's in there)
    • If this repository has alpha/beta/Milestone versions add include-pre-releases
    • If this repository has an active developed "maven-plugin-3.x"-branch also add a "release-drafter-3.x.yml" file
  • Add folder "ISSUE_TEMPALTE" with files "BUG.yml", "config.yml", "FEATURE.yml"
    • Update "config.yml" with URL to old JIRA (on shared JIRA projects the URL must include the component)
  • In the "workflow" folder add/update
    • Add "pr-automation.yml"
    • Add/Update "release-drafter.yml" so it also includes "workflow_dispatch:" for manual interaction
    • Add "stale.yml" and choose a time when to check for stale issues (should not be the same for all repositories)
  • In the projects root folder
    • Update "asf.yml" to enable Github issues and delete branch on merge
    • Update pom.xml and change the issueManagement-Element with system "GitHub Issues" and URLto the issues page (e.g. https://github.com/apache/maven-shared-utils/issues)
    • Update README.md (numbers are lines before updates)
      • Remove JIRA links (~line 20, 86, 93)
      • Place comment behind bug in line ~28 "You have found a bug..."
      • Remove line "make sure you have JIRA account" (~37)
      • Remove list point "Make sure your commit message is the proper format" (~63)
      • Remore the line to update the JIRA ticket (~71)
      • Remove paragraph "Making Trivial Changes" (~75)
      • Update / add social media linksof X, Bluesky, Mastodon (remove IRC) (~90)

Examples of PRs

The Github webhook does not react sometimes (we had this on at least 3 repositores). If the issue tab gets not activated after about 15 minutes, do a whitespace change to a file, to trigger it again. Recommendation from INFRA-26849 - Getting issue details... STATUS

Step 3.1 Create PR based on/for "maven-plugin-3.x"-release branch (if there is an active one)

If this repository has an active developed "maven-plugin-3.x"-branch 

  • Inside .github folder
    • Add / update "release-drafter.yml"
      • branch name to release branch
      • with config-name release-drafter-3.x.yml
  • insider github/workflow folder
    • Add "pr-automation.yml"
  • Inside projects root folder
    • Update pom.xml and change the issueManagement-Element (see above)
    • Update README.md (see above)

Example for 3.x-release branch PR :  maven-site-plugin (Note: we learned later that the changes in the asf.yml are not needed)

Step 4: Update Maven site documentation

The links for "Issue Tracking" on the Maven's site page have to be aligned.

  • Update "content/markdown/scm.md"
  • Update "content/apt/shared/index.apt" (for shared components) or "content/apt/plugins/index.apt" (for plugins)

Example PR (shared components): https://github.com/apache/maven-site/pull/784/files

Step 5: Disable creation of new Jira issues

To disable the creation of new Jira issues the task is different depending on if there is a dedicated Jira project matching the GH repository or if it's a shared one.

Dedicated Project

If there is a dedicated project, INFRA-Team has to apply the "Maven no new issues" permission schema.

To achieve this a request has to be created for them, example: INFRA-26792 - Getting issue details... STATUS

The PMC member should also add "(Moved to GitHub Issues)" to Jira project name.

Project with component

If the projects is shared (example MSHARED) the according "Jira component" has to be archived by a PMC member. The PMC member should also add a note that issue creation has been moved to Github into the compo.

Example: https://issues.apache.org/jira/projects/MSHARED?selectedItem=com.atlassian.jira.jira-projects-plugin:components-page

Step 6: Update Jira project description

The Jira project description needs be updated to indicated that the project was moved to GH. 

A PMC member needs to add (Moved to GitHub Issues) to project description.

Repositories / project status (Phase 1 only)


GitHub repoJira projectGH Issues enabledJira permission changesissues 
PRDone?

Release and Milestone(s)

created?

MNGSITE-
Update
maven-siteMNGSITEPR #599 (tick)(tick)(tick)

no new issue (tick) INFRA-26406 - Getting issue details... STATUS

Getting issues...

core https://github.com/apache/maven-sources/blob/master/default.xml#L30
maven-build-cache-extensionMBUILDCACHE
(tick)
(tick)

no new issue (tick) INFRA-26776 - Getting issue details... STATUS

Getting issues...

mavenMNG

PR #2413 (4.x)

#2414 (3.9.x)

(tick)(tick)#805 (tick)

no new issue (tick)

INFRA-26894 - Getting issue details... STATUS

Getting issues...

maven-mvnd--(tick)(tick)(tick)

-

-

maven-integration-testing

-merged into maven core, skipped---

-

-

maven-resolver

MRESOLVER

#734 (2.x)

#735 (1.9.x)

(tick)(tick)#804 (tick)

no new issue (tick)

INFRA-26894 - Getting issue details... STATUS

Getting issues...

maven-resolver-ant-tasks

MRESOLVER ant#55(tick)(tick)#804 (tick)

no new issue (tick)

INFRA-26894 - Getting issue details... STATUS


maven-wrapper

MWRAPPERPR #169(tick)(tick)(tick)

no new issue (tick)

INFRA-26870 - Getting issue details... STATUS

Getting issues...

plugins/core https://github.com/apache/maven-sources/blob/master/default.xml#L39
maven-clean-plugin

MCLEAN

PR #85(tick)(tick)(tick)

no new issue (tick)

INFRA-26489 - Getting issue details... STATUS

Getting issues...

maven-compiler-plugin

MCOMPILER

PR #287(tick)(tick)(tick)

no new issue (tick)

INFRA-26543 - Getting issue details... STATUS

Getting issues...

maven-deploy-plugin

MDEPLOY

PR #105(tick)(tick)(tick)

no new issue (tick)

INFRA-26565 - Getting issue details... STATUS

Getting issues...

maven-install-plugin

MINSTALL

PR #102(tick)(tick)(tick)

no new issue (tick)

INFRA-26565 - Getting issue details... STATUS

Getting issues...

maven-resources-plugin

MRESOURCES

PR #95(tick)(tick)(tick)

no new issue (tick)

INFRA-26650 - Getting issue details... STATUS

Getting issues...

maven-site-plugin

MSITE


#234 (Mvn 3)

#233 (Mvn 4)


(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

surefire

SUREFIRE

#831(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

maven-verifier-plugin

MVERIFIER

#9(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

plugins/packaging https://github.com/apache/maven-sources/blob/master/default.xml#L48
maven-ear-plugin

MEAR


PR #132(tick)(tick)PR #744 (tick)

no new issue (tick) INFRA-26682 - Getting issue details... STATUS

Getting issues...

maven-ejb-plugin

MEJB

PR #44(tick)(tick)PR #748 (tick)

no new issue (tick) INFRA-26734 - Getting issue details... STATUS

Getting issues...

maven-jar-plugin

MJAR


PR #126(tick)(tick)PR #746 (tick)

no new issue (tick)

INFRA-26682 - Getting issue details... STATUS

Getting issues...

maven-rar-plugin

MRAR


PR #36(tick)(tick)PR #748 (tick)

no new issue (tick) INFRA-26734 - Getting issue details... STATUS

Getting issues...

maven-war-plugin

MWAR

PR #84(tick)(tick)PR #745 (tick)

no new issue (tick) INFRA-26682 - Getting issue details... STATUS

Getting issues...

maven-acr-plugin

MACR


PR #48(tick)(tick)PR #748 (tick)

no new issue (tick)

INFRA-26734 - Getting issue details... STATUS

Getting issues...

maven-shade-plugin

MSHADE

PR #253(tick)(tick)PR #748 (tick)

no new issue (tick)

INFRA-26734 - Getting issue details... STATUS

Getting issues...

maven-source-plugin

MSOURCES

#57 (Mvn 3)

#56 (Mvn 4)

(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

maven-jlink-plugin

MJLINK

PR#243

release drafter and stale missing

(tick)(tick)(tick)

no new issue (tick)

INFRA-26473 - Getting issue details... STATUS

Getting issues...

maven-jmod-plugin

MJMOD

PR #40(tick)(tick)PR #748 (tick)

no new issue (tick)

INFRA-26734 - Getting issue details... STATUS

Getting issues...

plugins/reporting https://github.com/apache/maven-sources/blob/master/default.xml#L48
maven-changelog-plugin

MCHANGELOG


#39(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

maven-changes-plugin

MCHANGES

#122(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

maven-checkstyle-plugin

MCHECKSTYLE


#172(tick)(tick)#753 (tick)

now new issue (tick)

INFRA-26749 - Getting issue details... STATUS

Getting issues...

maven-doap-plugin

MDOAP

#39(tick)(tick)#762 (tick)

no new issue (tick)

INFRA-26768 - Getting issue details... STATUS

Getting issues...

maven-javadoc-plugin

MJAVADOC


#365(tick)(tick)#762 (tick)

no new issue (tick)

INFRA-26768 - Getting issue details... STATUS

Getting issues...

maven-jdeps-plugin

MJDEPS


#23(tick)(tick)#762 (tick)

no new issue (tick)

INFRA-26768 - Getting issue details... STATUS

Getting issues...

maven-jxr

JXR


#137(tick)(tick)#762 (tick)

no new issue (tick)

INFRA-26768 - Getting issue details... STATUS

Getting issues...

maven-linkcheck-plugin

MLINKCHECK

#7(tick)(tick)#762 (tick)

no new issue (tick)

INFRA-26768 - Getting issue details... STATUS

Getting issues...

maven-pmd-plugin

MPMD


PR #184(tick)(tick)PR #748 (tick)

no new issue (tick)

INFRA-26734 - Getting issue details... STATUS

Getting issues...

maven-project-info-reports-plugin

MPIR

PR #102(tick)(tick)(tick)

no new issue (tick)

INFRA-26565 - Getting issue details... STATUS

Getting issues...

plugins/tools https://github.com/apache/maven-sources/blob/master/default.xml#L70
maven-antrun-pluginMANTRUN#116(tick)(tick)#771 (tick)

no new issue (tick)

INFRA-26771 - Getting issue details... STATUS

Getting issues...

maven-archetypeARCHETYPEPR #250(tick)(tick)(tick)

no new issue (tick) INFRA-26418 - Getting issue details... STATUS

Getting issues...

maven-artifact-plugin

MARTIFACT#88(tick)(tick)#771 (tick)

no new issue (tick)

INFRA-26771 - Getting issue details... STATUS

Getting issues...

maven-assembly-pluginMASSEMBLY#219(tick)(tick)#771 (tick)

no new issue (tick)

INFRA-26771 - Getting issue details... STATUS

Getting issues...

maven-dependency-pluginMDEP#522(tick)(tick)#762 (tick)

no new issue (tick)

INFRA-26768 - Getting issue details... STATUS

Getting issues...

maven-enforcerMENFORCER#363(tick)(tick)#771 (tick)

no new issue (tick)

INFRA-26771 - Getting issue details... STATUS

Getting issues...

maven-gpg-pluginMGPG

#134

#136 😣

(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-help-pluginMPH#131(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-invoker-pluginMINVOKER#286(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-jarsigner-pluginMJARSIGNER#50(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-jdeprscan-pluginMJDEPRSCAN#37(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-plugin-toolsMPLUGIN#400(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-releaseMRELEASE#241(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-remote-resources-pluginMRRESOURCES#83(tick)(tick)#775 (tick)

now new issue (tick)

INFRA-26815 - Getting issue details... STATUS

Getting issues...

maven-scmSCM#242(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-scm-publish-pluginMSCMPUB#55(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-scripting-pluginMSCRIPTING#35(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-stage-pluginMSTAGE#19(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

maven-toolchains-pluginMTOOLCHAINS#55(tick)(tick)#775 (tick)

no new issue (tick)

INFRA-26792 - Getting issue details... STATUS

Getting issues...

shared https://github.com/apache/maven-sources/blob/master/default.xml#L70

maven-archiver

MSHARED
maven-archiver

#92 (4.x)

#93 (3.x)

(tick)(tick)#779 (tick)

component archived (tick)

Getting issues...

maven-artifact-transfer
deprecated, skipped for now, maybe later




maven-common-artifact-filters
MSHARED
maven-common-artifact-filters
#38(tick)(tick)#779 (tick)

component archived (tick) 

Getting issues...

maven-dependency-analyzerMSHARED maven-dependency-analyzerPR #142(tick)

component maven-dependency-analyzer archived

Getting issues...

maven-dependency-tree

MSHARED

maven-dependency-tree
#53(tick)(tick)#779 (tick)

component archived (tick) 

Getting issues...

maven-file-managementMSHARED file-managementPR #44(tick)(tick)(tick)

component file-management archived

Getting issues...

maven-filtering

MSHARED

maven-filtering

#154 (4.x)

#155 (3.x)

(tick)(tick)#779 (tick)

component archived (tick) 

Getting issues...

maven-invoker

MSHARED

maven-invoker

#85(tick)(tick)#782 (tick)

component archived (tick) 

Getting issues...

maven-jarsigner

MSHARED

maven-jarsigner

#32

(tick) 

(tick)#784 (tick)

component archived (tick)

Getting issues...

maven-mapping

MSHARED

maven-mapping

#20(tick)(tick)#1342 (tick)

not archived (error)

Getting issues...

maven-project-utils

non-active project / to be archived

skipped for now, maybe later






maven-reporting-api

#24 (4.x)

#25 (3.x)

(tick)


(tick)#784 (tick)

component archived (tick)

Getting issues...

maven-reporting-exec
#32

(tick)

(tick)#784 (tick)

component archived (tick)

Getting issues...

maven-reporting-impl

#67 (4.x)

#68 (3.x)

(tick)

(tick)#784 (tick)

component archived (tick)

Getting issues...

maven-script-interpreter
#129(tick)(tick)#786  (tick)

component archived (tick)

Getting issues...

maven-shared-incremental
#32(tick)(tick)#786  (tick)

component archived (tick)

Getting issues...

maven-shared-io
#30(tick)(tick) #786 (tick)

component archived (tick)

Getting issues...

maven-shared-jar
#56(tick)(tick) #786 (tick)

component archived (tick)

Getting issues...

maven-shared-resourcesMSHARED maven-shared-resourcesPR #26(tick)(tick)(tick)

component maven-shared-resources archived

Getting issues...

maven-shared-utils


#195(tick)(tick) #786 (tick)

component archived (tick)

Getting issues...

maven-verifier
#106(tick)(tick) #786 (tick)

component archived (tick)

Getting issues...

doxia https://github.com/apache/maven-sources/blob/master/default.xml#L113

maven-doxia

DOXIA#267(tick)(tick)

#48 (doxia) (tick)

#798 (maven) (tick)

no new issue (tick)

INFRA-26870 - Getting issue details... STATUS

Getting issues...

maven-doxia-site-#47(tick)N/AN/AN/A
maven-doxia-sitetoolsDOXIASITETOOLS#202(tick)(tick)#48 (tick)

no new issue (tick)

INFRA-26870 - Getting issue details... STATUS

Getting issues...

maven-doxia-book-maven-pluginDOXIATOOLS Doxia Book Maven Plugin#1(tick)(tick)#48 (tick)component archived (tick)
maven-doxia-book-rendererDOXIATOOLS Doxia Book Renderer#6(tick)(tick)#48 (tick)component archived (tick)
maven-doxia-converterDOXIATOOLS Doxia Converter#97(tick)(tick)#48 (tick) component archived (tick)
maven-doxia-linkcheckDOXIATOOLS Doxia Linkcheck#11(tick)(tick)#48 (tick)component archived (tick)
misc https://github.com/apache/maven-sources/blob/master/default.xml#L121
maven-archetypes

MARCHETYPES

PR #40(tick)(tick)(tick)

no new issues (tick)
INFRA-26809 - Getting issue details... STATUS

Getting issues...

maven-parentMPOM mavenPR #175(tick)(tick)(tick)

no new issues (tick) INFRA-25730 - Getting issue details... STATUS

Getting issues...

maven-apache-parent

MPOM asf

PR #216(tick)(tick)(tick)

no new issues (tick) INFRA-25730 - Getting issue details... STATUS

Getting issues...

maven-apache-resourcesMASFRESPR #23 (tick)(tick)(tick)

no new issues (tick) INFRA-26417 - Getting issue details... STATUS

Getting issues...

maven-default-skinMSKINS default#1(tick)(tick)#803 (tick)component archived (tick)
maven-fluido-skinMSKINS fluidoPR #75(tick)(tick)(tick)component Fluido Skin Archived

Getting issues...

maven-dist-tool-PR #72(tick)(tick)(tick)

-

-
maven-gh-actions-shared-PR #124(tick)(tick)(tick)

-

-
maven-indexerMINDEXER#426(tick)(tick)#801 (tick)

no new issues (tick)

INFRA-26870 - Getting issue details... STATUS

Getting issues...

maven-plugin-testingMPLUGINTESTINGPR #47(tick)(tick)(tick)

no new issues (tick)

INFRA-26469 - Getting issue details... STATUS

Getting issues...

maven-wagonWAGON

#157 (4.x)

#158 (3.x)

(tick)(tick)#801 (tick)

no new issues (tick)

INFRA-26870 - Getting issue details... STATUS

Getting issues...

  • No labels