elharo commented on code in PR #1639: URL: https://github.com/apache/maven-site/pull/1639#discussion_r3743905911
########## content/markdown/developers/retirement-plan-plugins.md: ########## @@ -100,18 +100,27 @@ If the vote passes, make one final release of the plugin (with its own standard ## Step 3: Clean up after the release -1. Remove the `.Jenkinsfile` from all branches. This will remove the project from https://builds.apache.org/job/maven-box/ +Everything that changes the repository has to be merged **before** INFRA archives it. An archived repository is read only, so anything left behind is frozen there permanently, and correcting it costs an unarchive/fix/re-archive round trip. + +1. Remove the `Jenkinsfile` from all branches. This will remove the project from the `maven-box` folder on https://ci-maven.apache.org/job/Maven/job/maven-box/ 2. Remove the `.github` directory from default branch. This will remove GitHub Actions -3. Add " (RETIRED)" at the end of the project name in GitHub by updating `.asf.yaml` -4. Ask INFRA to archive git repos (gitbox + github) -5. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) -6. Comment the [dist-tool configuration](https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html) entry. Also comment the plugin's entry in the `GetPrerequisites.java` and `ListBranchesReport` files. -7. Remove from `Source Repository` + 1. Deleting the directory stops new runs but leaves the old ones and their caches behind. Delete the workflow run history and the Actions caches as well, since they are frozen with the rest of the repository and serve no purpose once nothing can run again. +3. Delete stale topic branches. Whatever survives is frozen by the archive, and a branch that still carries a `Jenkinsfile` can keep a build job alive. +4. Update `.asf.yaml`: + 1. Add " (RETIRED)" at the end of the project name. + 2. Point `homepage` at https://maven.apache.org/ rather than the plugin's own site, which moves to the archive along with the plugin. Note that asfyaml only applies a homepage when one is given: removing the key stops it being reasserted but does not clear what GitHub already stores. + 3. Remove `autolink_jira`. This stops the file claiming a Jira project that is being archived, though it does not delete autolinks GitHub has already created — ask INFRA for that. + 4. Leave `features.issues` enabled. An archived repository keeps its issues readable, so disabling the feature would hide every report, including any migrated out of Jira. +5. Replace the `README` with a short retirement notice. The file is otherwise a guide to forking the repository and opening pull requests, which is not actionable on a retired plugin. Keep it to what a visitor needs: that the plugin is retired, the last released version, and a link to the [mailing lists](https://maven.apache.org/mailing-lists.html) for questions. Do not link the plugin's own site, which will not outlive the plugin. +6. Ask INFRA to archive git repos (gitbox + github). Ask in the same ticket for the plugin's Jira project to be archived, if it has one. +7. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) Review Comment: When relevant, ########## content/markdown/developers/retirement-plan-plugins.md: ########## @@ -100,18 +100,27 @@ If the vote passes, make one final release of the plugin (with its own standard ## Step 3: Clean up after the release -1. Remove the `.Jenkinsfile` from all branches. This will remove the project from https://builds.apache.org/job/maven-box/ +Everything that changes the repository has to be merged **before** INFRA archives it. An archived repository is read only, so anything left behind is frozen there permanently, and correcting it costs an unarchive/fix/re-archive round trip. + +1. Remove the `Jenkinsfile` from all branches. This will remove the project from the `maven-box` folder on https://ci-maven.apache.org/job/Maven/job/maven-box/ 2. Remove the `.github` directory from default branch. This will remove GitHub Actions -3. Add " (RETIRED)" at the end of the project name in GitHub by updating `.asf.yaml` -4. Ask INFRA to archive git repos (gitbox + github) -5. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) -6. Comment the [dist-tool configuration](https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html) entry. Also comment the plugin's entry in the `GetPrerequisites.java` and `ListBranchesReport` files. -7. Remove from `Source Repository` + 1. Deleting the directory stops new runs but leaves the old ones and their caches behind. Delete the workflow run history and the Actions caches as well, since they are frozen with the rest of the repository and serve no purpose once nothing can run again. +3. Delete stale topic branches. Whatever survives is frozen by the archive, and a branch that still carries a `Jenkinsfile` can keep a build job alive. +4. Update `.asf.yaml`: + 1. Add " (RETIRED)" at the end of the project name. + 2. Point `homepage` at https://maven.apache.org/ rather than the plugin's own site, which moves to the archive along with the plugin. Note that asfyaml only applies a homepage when one is given: removing the key stops it being reasserted but does not clear what GitHub already stores. Review Comment: Note that asfyaml only applies a homepage when one is given. Removing the key stops it being reasserted but does not clear what GitHub already stores. ########## content/markdown/developers/retirement-plan-plugins.md: ########## @@ -100,18 +100,27 @@ If the vote passes, make one final release of the plugin (with its own standard ## Step 3: Clean up after the release -1. Remove the `.Jenkinsfile` from all branches. This will remove the project from https://builds.apache.org/job/maven-box/ +Everything that changes the repository has to be merged **before** INFRA archives it. An archived repository is read only, so anything left behind is frozen there permanently, and correcting it costs an unarchive/fix/re-archive round trip. + +1. Remove the `Jenkinsfile` from all branches. This will remove the project from the `maven-box` folder on https://ci-maven.apache.org/job/Maven/job/maven-box/ 2. Remove the `.github` directory from default branch. This will remove GitHub Actions -3. Add " (RETIRED)" at the end of the project name in GitHub by updating `.asf.yaml` -4. Ask INFRA to archive git repos (gitbox + github) -5. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) -6. Comment the [dist-tool configuration](https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html) entry. Also comment the plugin's entry in the `GetPrerequisites.java` and `ListBranchesReport` files. -7. Remove from `Source Repository` + 1. Deleting the directory stops new runs but leaves the old ones and their caches behind. Delete the workflow run history and the Actions caches as well, since they are frozen with the rest of the repository and serve no purpose once nothing can run again. +3. Delete stale topic branches. Whatever survives is frozen by the archive, and a branch that still carries a `Jenkinsfile` can keep a build job alive. +4. Update `.asf.yaml`: + 1. Add " (RETIRED)" at the end of the project name. + 2. Point `homepage` at https://maven.apache.org/ rather than the plugin's own site, which moves to the archive along with the plugin. Note that asfyaml only applies a homepage when one is given: removing the key stops it being reasserted but does not clear what GitHub already stores. + 3. Remove `autolink_jira`. This stops the file claiming a Jira project that is being archived, though it does not delete autolinks GitHub has already created — ask INFRA for that. + 4. Leave `features.issues` enabled. An archived repository keeps its issues readable, so disabling the feature would hide every report, including any migrated out of Jira. +5. Replace the `README` with a short retirement notice. The file is otherwise a guide to forking the repository and opening pull requests, which is not actionable on a retired plugin. Keep it to what a visitor needs: that the plugin is retired, the last released version, and a link to the [mailing lists](https://maven.apache.org/mailing-lists.html) for questions. Do not link the plugin's own site, which will not outlive the plugin. Review Comment: "which will not outlive the plugin" That's unfortunate. We should try not to break links. Keeping old docs around is cheap, and code archaeology is a thing. ########## content/markdown/developers/retirement-plan-plugins.md: ########## @@ -100,18 +100,27 @@ If the vote passes, make one final release of the plugin (with its own standard ## Step 3: Clean up after the release -1. Remove the `.Jenkinsfile` from all branches. This will remove the project from https://builds.apache.org/job/maven-box/ +Everything that changes the repository has to be merged **before** INFRA archives it. An archived repository is read only, so anything left behind is frozen there permanently, and correcting it costs an unarchive/fix/re-archive round trip. + +1. Remove the `Jenkinsfile` from all branches. This will remove the project from the `maven-box` folder on https://ci-maven.apache.org/job/Maven/job/maven-box/ 2. Remove the `.github` directory from default branch. This will remove GitHub Actions -3. Add " (RETIRED)" at the end of the project name in GitHub by updating `.asf.yaml` -4. Ask INFRA to archive git repos (gitbox + github) -5. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) -6. Comment the [dist-tool configuration](https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html) entry. Also comment the plugin's entry in the `GetPrerequisites.java` and `ListBranchesReport` files. -7. Remove from `Source Repository` + 1. Deleting the directory stops new runs but leaves the old ones and their caches behind. Delete the workflow run history and the Actions caches as well, since they are frozen with the rest of the repository and serve no purpose once nothing can run again. +3. Delete stale topic branches. Whatever survives is frozen by the archive, and a branch that still carries a `Jenkinsfile` can keep a build job alive. +4. Update `.asf.yaml`: + 1. Add " (RETIRED)" at the end of the project name. + 2. Point `homepage` at https://maven.apache.org/ rather than the plugin's own site, which moves to the archive along with the plugin. Note that asfyaml only applies a homepage when one is given: removing the key stops it being reasserted but does not clear what GitHub already stores. + 3. Remove `autolink_jira`. This stops the file claiming a Jira project that is being archived, though it does not delete autolinks GitHub has already created — ask INFRA for that. + 4. Leave `features.issues` enabled. An archived repository keeps its issues readable, so disabling the feature would hide every report, including any migrated out of Jira. +5. Replace the `README` with a short retirement notice. The file is otherwise a guide to forking the repository and opening pull requests, which is not actionable on a retired plugin. Keep it to what a visitor needs: that the plugin is retired, the last released version, and a link to the [mailing lists](https://maven.apache.org/mailing-lists.html) for questions. Do not link the plugin's own site, which will not outlive the plugin. +6. Ask INFRA to archive git repos (gitbox + github). Ask in the same ticket for the plugin's Jira project to be archived, if it has one. +7. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) +8. Comment the [dist-tool configuration](https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html) entry. Also comment the plugin's entry in the `GetPrerequisites.java` and `ListBranchesReport` files. +9. Remove from `Source Repository` 1. [https://maven.apache.org/scm.html](https://maven.apache.org/scm.html) (includes the plantUML diagram) - 2. [https://github.com/apache/maven-sources](https://github.com/apache/maven-sources) -8. Remove distribution from current [dist area](https://dist.apache.org/repos/dist/release/maven/) (history remains available in [archive](https://archive.apache.org/dist/maven/)). This needs to be done by PMC members. -9. Update board report. This needs to be done by PMC members. -10. Announce the fact that the plugin has been retired/moved on the announce and users mailing lists. Explain to people what they should do if they would like to continue development of the plugin. Example for retirement email: + 2. [https://github.com/apache/maven-sources](https://github.com/apache/maven-sources), moving the entry from `default.xml` to `retired.xml` and removing the matching `<module>` from the aggregator pom. Both, or the aggregator build breaks for everyone who syncs the manifest. +10. Remove distribution from current [dist area](https://dist.apache.org/repos/dist/release/maven/) (history remains available in [archive](https://archive.apache.org/dist/maven/)). This needs to be done by PMC members. Remove the `.asc` and `.sha512` files as well as the archive itself — leaving them behind publishes a signature for a file that no longer exists. Review Comment: Itself — leaving them behind publishes a signature for a file that no longer exists. --> tself. Leaving them behind publishes a signature for a file that no longer exists. ########## content/markdown/developers/retirement-plan-plugins.md: ########## @@ -100,18 +100,27 @@ If the vote passes, make one final release of the plugin (with its own standard ## Step 3: Clean up after the release -1. Remove the `.Jenkinsfile` from all branches. This will remove the project from https://builds.apache.org/job/maven-box/ +Everything that changes the repository has to be merged **before** INFRA archives it. An archived repository is read only, so anything left behind is frozen there permanently, and correcting it costs an unarchive/fix/re-archive round trip. + +1. Remove the `Jenkinsfile` from all branches. This will remove the project from the `maven-box` folder on https://ci-maven.apache.org/job/Maven/job/maven-box/ 2. Remove the `.github` directory from default branch. This will remove GitHub Actions -3. Add " (RETIRED)" at the end of the project name in GitHub by updating `.asf.yaml` -4. Ask INFRA to archive git repos (gitbox + github) -5. When relevant update summary pages for [plugins](https://maven.apache.org/plugins/index.html) or [shared components](https://maven.apache.org/shared/index.html) -6. Comment the [dist-tool configuration](https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html) entry. Also comment the plugin's entry in the `GetPrerequisites.java` and `ListBranchesReport` files. -7. Remove from `Source Repository` + 1. Deleting the directory stops new runs but leaves the old ones and their caches behind. Delete the workflow run history and the Actions caches as well, since they are frozen with the rest of the repository and serve no purpose once nothing can run again. +3. Delete stale topic branches. Whatever survives is frozen by the archive, and a branch that still carries a `Jenkinsfile` can keep a build job alive. +4. Update `.asf.yaml`: + 1. Add " (RETIRED)" at the end of the project name. + 2. Point `homepage` at https://maven.apache.org/ rather than the plugin's own site, which moves to the archive along with the plugin. Note that asfyaml only applies a homepage when one is given: removing the key stops it being reasserted but does not clear what GitHub already stores. + 3. Remove `autolink_jira`. This stops the file claiming a Jira project that is being archived, though it does not delete autolinks GitHub has already created — ask INFRA for that. Review Comment: has already created. Ask INFRA for that. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
