Skip to content

Migration to toon-format Organization - Main Tracking Issue #32

@felipestanzani

Description

@felipestanzani

This is the main tracking issue for migrating JToon from felipestanzani/JToon to toon-format/JToon and updating the package namespace from com.felipestanzani to dev.toonformat.

Migration Overview

Following discussions about bringing JToon into the TOON Format organization, we are migrating the repository and updating all package namespaces, Maven coordinates, and documentation to align with the unified TOON Format ecosystem.

Goals

  • Transfer repository from felipestanzani/JToon to toon-format/JToon
  • Migrate package namespace from com.felipestanzani.jtoon to dev.toonformat.jtoon
  • Update Maven group ID from com.felipestanzani to dev.toonformat
  • Maintain full backward compatibility where possible
  • Preserve all existing code and git history
  • Align documentation and structure with other TOON implementations
  • Ensure full SPEC.md compliance using language-agnostic tests
  • Set up CI/CD with GitHub Actions for spec compliance validation
  • Handle Maven Central publishing migration

Migration Checklist

  • Phase 1: Documentation and Standards

    • Adapt README to match unified structure (like toon-dotnet, toon-python)
    • Add standard CODE_OF_CONDUCT.md
    • Add standard CONTRIBUTING.md
    • Update CHANGELOG.md with migration notes
  • Phase 2: Build Configuration

    • Update build.gradle with new group ID and artifact ID
    • Update gradle/publishing.gradle with new Maven coordinates
    • Update settings.gradle if needed
    • Update all build scripts and configuration files
  • Phase 3: CI/CD and Testing

    • Update GitHub Actions workflows (build.yml, release.yml)
    • Update CI badges and repository URLs
    • Integrate language-agnostic test fixtures from spec repository
    • Set up spec compliance validation in CI
  • Phase 4: Code and Package Migration

    • Migrate package namespace from com.felipestanzani.jtoon to dev.toonformat.jtoon
    • Update all Java source files with new package declarations
    • Update all test files with new package declarations
    • Update package-info.java files with new namespace references
    • Update Javadoc references and links
  • Phase 5: Documentation Updates

    • Update README.md with new Maven coordinates and package names
    • Update all code examples in README.md
    • Update TOON-SPECIFICATION.md references
    • Update all documentation files with new URLs and references
  • Phase 6: Repository Transfer

    • Final verification before transfer
    • Transfer repository to toon-format organization
    • Update all repository URLs and references post-transfer
    • Set up organization team and maintainer access
    • Update GitHub repository settings and webhooks
  • Phase 7: Maven Central Migration

    • Prepare Maven Central migration plan
    • Set up new Maven Central publishing credentials (organization secrets)
    • Publish final version under old coordinates (deprecation notice)
    • Publish first version under new coordinates
    • Update Maven Central metadata and deprecation notices

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions