Make your existing component ready for ModuleSync

  • Create .sync.yml with the following content:

    :global:
      componentName: My Component (1)
    1 A human friendly component name. Used in the component’s README.md and as the display title for the Antora docs.
The component’s name (or "slug") is derived from the component’s GitHub repository name by removing the component- prefix.

You can locally test the impact of ModuleSync on an existing component. You need git and docker to do so. Also you need a working SSH agent that can be made accessible within a docker container. For more details have a look at the Makefile.

  • Clone modulesync-control

  • Add your component to managed_modules.yml (no need to commit/push)

  • Run make sync:noop

  • Check the results in `modules/<namespace>/<component name>'