Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate launch.groovy and merge functionality into diff.groovy #529

Closed
rnveach opened this issue Dec 24, 2020 · 9 comments · Fixed by #556
Closed

Deprecate launch.groovy and merge functionality into diff.groovy #529

rnveach opened this issue Dec 24, 2020 · 9 comments · Fixed by #556

Comments

@rnveach
Copy link
Member

rnveach commented Dec 24, 2020

Launch has outlived its purpose and should be deprecated as diff.groovy serves all our needs.

The only thing launch truthfully does now is no-error and no-exception testing. https://github.com/checkstyle/checkstyle/blob/master/.ci/no-exception-test.sh#L26-L27 . To support this, diff needs support to not-ignore the exclude paths as it is common to ignore java files that are only made for testing. Diff doesn't honor excludes by default.

#523 also needs to be done to merge that functionality.

This 2 should be the only functionalities needed to be merged into diff.groovy.

launch.groovy has to remain in repo until Checkstyle AND Sevntu is updated to remove all usage of it. Once Checkstyle AND Sevntu makes the conversion, then launch.groovy can be removed.

https://github.com/checkstyle/contribution/blob/master/checkstyle-tester/LAUNCH_GROOVY_README.md should be removed when launch if finally removed.

@rnveach
Copy link
Member Author

rnveach commented Dec 24, 2020

Basically a duplicate of #221

@rnveach
Copy link
Member Author

rnveach commented Jan 14, 2021

When launch is completely deleted from this repo, all current PRs in checkstyle will need to be rebased as existing ones will still reference a command that is gone and will fail without the rebase.

This is a breaking change.

@nrmancuso
Copy link
Member

Usage of launch in sevntu-checkstyle:

➜  sevntu.checkstyle git:(master) grep -R -A 2 "launch.groovy"
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}
--
sevntu-checks/.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
sevntu-checks/.ci/wercker.sh-      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
sevntu-checks/.ci/wercker.sh-      --sevntuVersion ${SEVNTU_POM_VERSION}

@nrmancuso
Copy link
Member

Usage of launch in checkstyle:

➜  checkstyle git:(issue-9170) grep -R -A 1 "launch.groovy"
.ci/no-exception-test.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/no-exception-test.sh-      --config ../../google_checks.xml --checkstyleVersion $CS_POM_VERSION
--
.ci/no-exception-test.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/no-exception-test.sh-      --config ../../sun_checks.xml --checkstyleVersion $CS_POM_VERSION
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
.ci/wercker.sh-      --config checks-only-javadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-for-wercker.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/wercker.sh-      --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects $PROJECTS --config $CONFIG \
.ci/wercker.sh-      --checkstyleVersion ${CS_POM_VERSION}
--
.ci/wercker.sh:  groovy ./launch.groovy --listOfProjects $PROJECTS --config $CONFIG \
.ci/wercker.sh-      --checkstyleVersion ${CS_POM_VERSION}
--
.ci/shippable.sh:  groovy launch.groovy --listOfProjects projects-for-circle.properties \
.ci/shippable.sh-    --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/shippable.sh:  groovy launch.groovy --listOfProjects projects-for-circle.properties \
.ci/shippable.sh-    --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/shippable.sh:  groovy launch.groovy --listOfProjects projects-for-circle.properties \
.ci/shippable.sh-    --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/shippable.sh:  groovy launch.groovy --listOfProjects projects-for-circle.properties \
.ci/shippable.sh-    --config checks-nonjavadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}
--
.ci/shippable.sh:  groovy launch.groovy --listOfProjects projects-to-test-on.properties \
.ci/shippable.sh-    --config checks-only-javadoc-error.xml --checkstyleVersion ${CS_POM_VERSION}

@nrmancuso
Copy link
Member

nrmancuso commented Jan 27, 2021

usage of launch in checkstyle-contribution:

➜  contribution git:(issue-529) ✗ grep -R -A 1 "groovy launch.groovy -"
patch-diff-report-tool/README.md:6) execute `groovy launch.groovy --listOfProjects projects-to-test-on.properties
patch-diff-report-tool/README.md-  --config my_check.xml --ignoreExceptions`
--
appveyor.yml:      CMD7: " && groovy launch.groovy -l projects-for-travis.properties -c checks-nonjavadoc-error.xml -i\""
appveyor.yml-    - JAVA_HOME: C:\Program Files\Java\jdk1.8.0
--
.ci/travis.sh:  groovy launch.groovy -l projects-for-travis.properties -c my_check.xml -i
.ci/travis.sh-  ;;
--
checkstyle-tester/diff.groovy:    command = """groovy launch.groovy --listOfProjects $cfg.listOfProjects
checkstyle-tester/diff.groovy-            --config $cfg.checkstyleCfg --ignoreExceptions --ignoreExcludes
--
checkstyle-tester/LAUNCH_GROOVY_README.md:groovy launch.groovy --listOfProjects projects-to-test-on.properties --config my_check.xml
checkstyle-tester/LAUNCH_GROOVY_README.md-```
--
checkstyle-tester/LAUNCH_GROOVY_README.md:groovy launch.groovy -l projects-to-test-on.properties -c my_check.xml
checkstyle-tester/LAUNCH_GROOVY_README.md-```
--
checkstyle-tester/LAUNCH_GROOVY_README.md:groovy launch.groovy -l projects-to-test-on.properties -c my_check.xml -i
checkstyle-tester/LAUNCH_GROOVY_README.md-```
--

nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
@nrmancuso
Copy link
Member

nrmancuso commented Jan 27, 2021

Leaving a note here for sevntu:

no-exceptions command will look like:

  groovy ./diff.groovy --listOfProjects projects-for-wercker.properties \
      --config checks-sevntu-error.xml --checkstyleVersion ${CS_POM_VERSION} \
      --sevntuVersion ${SEVNTU_POM_VERSION} --allowExcludes

nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Jan 27, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Feb 13, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Feb 13, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Feb 13, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Feb 14, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Feb 14, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Mar 20, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Mar 21, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Mar 21, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Mar 21, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Mar 23, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 3, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 3, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
nrmancuso added a commit to nrmancuso/contribution that referenced this issue Apr 7, 2021
@rnveach
Copy link
Member Author

rnveach commented Apr 25, 2021

@nmancus1 Where are we on this issue?

I believe we deprecated launch and merged into diff.
Did we finish moving checkstyle and sevntu to diff? If so we can remove launch and it's readme completely and close this issue.

@nrmancuso
Copy link
Member

I believe we deprecated launch and merged into diff.

Yes.

Did we finish moving checkstyle and sevntu to diff?

Yes, done at checkstyle/checkstyle#9278 and sevntu-checkstyle/sevntu.checkstyle#828 respectively.

I will finish up this week, thanks for the reminder :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants