Include metafacture-fix

[dr0i]

Merge metafacture-fix repository to ease maintenance and support burden as well as simplify development and use. See metafacture/metafacture-fix#298 for previous discussion.

Preconditions:

• Await the next fix/core release. Release Metafacture core 6.2.0 #580, Release metafacture-fix 1.2.0 based on core 6.2.0 metafacture-fix#390
• Resolve (i.e., close or merge) open pull requests.
• Freeze any activity in old repository.

Course of action:

• Fetch old repository into temporary branch (without tags, --no-tags).
• Merge temporary branch into integration branch (with history, --allow-unrelated-histories).
• Combine common files (README.md, build.gradle, etc.), preserve current subprojects (metafix*) and namespace (org.metafacture.metafix).
• Integrate into metafacture-runner.
• Verify working state (esp. w.r.t. dependencies) for both old and new subprojects (unit tests, integration tests, distribution; branch: 577-merge-metafacture-fix).
  • @blackwinter
  • @dr0i
  • @fsteeg
  • @TobiasNx
• Open pull request to merge. Merge metafacture-fix. #586

Post-migration steps:

• Transfer packages to new repository (apparently, Maven packages are always scoped to a repository which cannot be changed).
  • Delete packages in old repository.
  • Republish org.metafacture.metafix package versions in new repository.
• Verify working state in downstream projects (preview release: 577-merge-metafacture-fix-rc1-SNAPSHOT).
  • Limetrans (@blackwinter)
  • Metafacture Playground (@dr0i, @TobiasNx)
  • lobid-resources (@dr0i)
  • oersi (@fsteeg)
• Transfer open issues to new repository (can only be done individually). (@TobiasNx, @blackwinter)
  • Clean up labels and ensure matching names.
  • Add Metafix label to open issues.
  • Update issue references in the code (incl. integration tests). 9ed5d4e
• Update README.md and description to point to new repository. metafacture/metafacture-fix@6fa7faa
• Update/migrate documentation and wiki content. #673
• Archive old repository.
• After next (combined) release: Update/remove dependencies in downstream projects and workflows.

Cleanup:

• Remove metafix-runner (already done during merge).
• Clean up .gitignore file (remove obsolete patterns, structure metafacture-fix patterns). 402ee3c
• Update Checkstyle config:
  • Switch to newer tool version (toolVersion). a6b3d14
  • Enable checks for test files (checkstyleTest.enabled). 01a7351
  • Disallow static, non-final variables (StaticVariableName). 1a5e003
  • Enforce Javadoc comments for methods (MissingJavadocMethod). 2f57d06
• Find a way to run metafix integration tests only when necessary (would otherwise slow down all workflows, including pull request checks). This doesn't seem feasible; it's impossible to determine an integration test's up-to-dateness. Instead, they have been changed to run directly from the distribution instead of via Gradle (2661ab8), which reduces the test runtime by about 40-50 %, GitHub Actions runtime by about 30 %. Another option would be to let them run in parallel; but this would be considerably more complicated.

[blackwinter]

Status update:

I've successfully performed the outlined steps towards a potential merge (as of metafacture/metafacture-fix@b254549). This was initially meant as a dry-run, but seeing as it wasn't always straightforward along the way¹, I'd very much like to be able to use my current state for the actual merge (pull request). The only thing holding us back (AFAICS) is the pending release.

Can we agree on freezing all activity in the metafacture-fix repository right now? Meaning: No new commits and pull requests! Ideally, no new issues either. The release process itself doesn't matter since the version number and tags aren't carried over anyway.

Footnotes

1. I have yet to document the modifications made during the merge, but as soon as that's done I can push the integration branch. ↩

[blackwinter]

Modifications made while importing metafacture/metafacture-fix@b254549 (see 1784fda):

Modified files:

• .editorconfig
  • Added file extensions fix, md, mwe2, sh, vim, xtext and tmLanguage (from metafacture-fix).
• .github/workflows/build.yml
  • Dropped build step Grant execute permission for gradlew (previously in metafacture-fix).
  • Added environment variable METAFIX_LOG_PASSED (from metafacture-fix).
  • Added build steps Install language server and Install fix extension (from metafacture-fix).
• .github/workflows/publish.yml
  • Changed branch specification (from publish in metafacture-fix to *-rc*).
  • Changed publication task (from publish in metafacture-fix to publishAllPublicationsToGitHubPackagesRepository).
• .gitignore
  • Changed directory patterns for gradle and build (previously less strict in metafacture-core).
  • Added file patterns (from metafacture-fix).
• CONTRIBUTING.md
  • Updated links.
• README.md
  • Added sections (from metafacture-fix).
• build.gradle
  • Added plugin org.xtext.builder (from metafacture-fix).
  • Dropped plugin io.github.0ffz.github-packages (previously in metafacture-fix).
  • Increased guava dependency version (from 29.0-jre in metafacture-fix to 32.0.1-jre).
  • Increased slf4j dependency version (from 1.7.21 in metafacture-fix to 1.7.36).
  • Increased wiremock dependency version (from 2.33.2 in metafacture-fix to 2.35.0).
  • Decreased Checkstyle toolVersion (from 8.44 in metafacture-fix to 8.30).
  • Disabled Checkstyle for test files (previously in metafacture-fix).
  • Added task installServer (from metafacture-fix).
  • Added exclude generated files in plugin javadoc (from metafacture-fix).
  • Dropped repository LocalEmbedded (previously in metafacture-fix).
• config/checkstyle/checkstyle.xml
  • Added SuppressionSingleFilter for xtext-gen and test files (from metafacture-fix).
  • Dropped MissingJavadocMethod check (not satisfied by metafacture-fix).
  • Changed StaticVariableName configuration (previously more strict in metafacture-fix).
• metafacture-json/build.gradle
  • Changed version variable.
• metafacture-runner/build.gradle
  • Added plugin application (from metafacture-fix).
  • Added project dependency metafix (from metafix-runner).
  • Added dependency constraint for antlr-runtime (from metafix-runner).
  • Dropped lib directory configuration in distribution (implied by application plugin).
  • Dropped start scripts (previously in metafacture-fix; superseded by bespoke main scripts).
  • Added pass system properties in JavaExec tasks (from metafix-runner).
• metafix-ide/build.gradle
  • Added common metafacture-fix configuration (previously in top-level build file in metafacture-fix).
• metafix-vsc/fix.tmLanguage
  • Updated links.
• metafix-vsc/package.json
  • Updated links.
• metafix-web/build.gradle
  • Changed metafacture-core dependencies (from external dependencies in metafacture-fix to project dependencies).
  • Added common metafacture-fix configuration (previously in top-level build file in metafacture-fix).
• metafix/build.gradle
  • Changed metafacture-core dependencies (from external dependencies in metafacture-fix to project dependencies).
  • Added common metafacture-fix configuration (previously in top-level build file in metafacture-fix).
  • Dropped system property org.metafacture.metafix.logLevel (obsolete).
  • Dropped task install (now in top-level build file).
• metafix/integrationTest.sh
  • Changed Gradle task (from :metafix-runner:run in metafacture-fix to :metafacture-runner:run).
• settings.gradle
  • Added subprojects metafix, metafix-ide and metafix-web (from metafacture-fix).
  • Dropped feature preview STABLE_CONFIGURATION_CACHE (previously in metafacture-fix).

Deleted files and directories:

• .settings/ (ignored)
• MAINTAINING.md (obsolete)
• metafix-ide/.checkstyle (ignored)
• metafix-ide/.settings/ (ignored)
• metafix-runner/build.gradle (integrated into metafacture-runner)
• metafix-vsc/.vscode/ (ignored)
• metafix-web/.checkstyle (ignored)
• metafix-web/.settings/ (ignored)
• metafix/.checkstyle (ignored)
• metafix/.settings/ (ignored)
• metafix/src/main/resources/log4j.xml (obsolete)