Skip to main content

Repository Push/Pull/Reset Workflow

This workflow promotes reuse, collaboration, updates, and rollback in a structured and scalable way.

๐Ÿ“ฆ What Is the Repository Workflow?

Joomla Component Builder provides a Git-based mechanism for syncing JCB entities between your local instance and remote repositories. This allows you to:

  • Pull (import) prebuilt or updated entities from a source (official or custom)
  • Push (export) your local changes to a Git repo
  • Reset (sync) your entity to match the latest upstream version

This makes your JCB development process modular, collaborative, and easy to maintain.

๐Ÿ› ๏ธ Supported Entity Types

Repository workflows are available for many JCB entities:

  • Blueprints (components)
  • Field types
  • Admin views, site views, custom admin views
  • Dynamic GETs
  • Layouts, templates, snippets
  • Custom code entries
  • Menus, permissions, dashboards
  • Documentation blocks

Each type can be linked to a shared Git-based package to allow cross-project syncing.

๐Ÿš€ How to Use Push, Pull, Reset

  1. Connect your JCB installation to a Git-based package repository (e.g., official JCB repo, your own Git remote).
  2. Open an entity and choose:
    • Push โ€“ Export your changes to the repository
    • Pull โ€“ Import changes or new items from upstream
    • Reset โ€“ Force your local entity to match the upstream version
  3. Youโ€™ll see update logs and confirmation prompts before changes are applied.

๐Ÿ” Benefits

  • Share reusable elements across projects or teams
  • Keep blueprints up to date with central definitions
  • Fork and customize only what you need
  • Roll back unwanted changes using reset
  • Track version history of every synced item
  • Keep consistent data structures across environments (dev/stage/prod)

๐Ÿ” Secure by Design

JCB only allows updates from known and configured repositories. You can control:

  • Which entities sync with which sources
  • Whether auto-push/pull is allowed per item
  • Whether to allow overwrite/reset of local changes

๐Ÿง  Common Use Cases

  • Sync a custom Admin View across multiple components
  • Fork and evolve a community-maintained blueprint
  • Pull the latest Dynamic GET queries into a dashboard view
  • Reset an entity after unwanted modifications
  • Push a layout/snippet to a design teamโ€™s shared repo

๐Ÿ“˜ Conclusion

The Repository Push/Pull/Reset workflow transforms JCB from a local builder into a distributed development platform. Whether you're managing one project or dozens, this version-controlled flow brings consistency, reusability, and teamwork to Joomla component developmentโ€”right from inside the GUI.