dotCMS / dotCMS/core

Update `@dotcms/analytics` Library Build Process for Automatic Asset Generation (IIEF)

Open
#32,517 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Team : Falcon Type : Task
Dominant language
Java
Stars
970
Forks
486
Avg merge
3d 33m
Merged PRs (30d)
170

Description

Task

The @dotcms/analytics library for Headless has been updated and need to be updated the generation of IIFE version. Currently, this library needs to be manually added to git after building. We need to verify that it's working correctly and implement an automatic build process similar to what was done with Block Editor and Binary Field, where the library is generated and uploaded to assets during the build process.

Current Problem:

  • The @dotcms/analytics library generates an IIFE version
  • Manual git addition is required after build
  • Process is not automated like other similar libraries

Required Actions:

  • Verify the updated library is functioning correctly
  • Implement automatic asset generation during build
  • Follow the same pattern used for Block Editor and Binary Field
Proposed Objective

Code Maintenance

Proposed Priority

Priority 3 - Average

Acceptance Criteria
  • Verify @dotcms/analytics library IIFE generation is working correctly
  • Implement automatic build process that generates and uploads the library to assets
  • Remove the need for manual git addition after build
  • Ensure the process follows the same pattern as Block Editor and Binary Field
  • Test the automated process in a build environment
External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the existing Block Editor and Binary Field build processes with the @dotcms/analytics library's IIFE generation. Verify the current IIFE output, then trace how those comparable libraries are generated and uploaded to assets during a build. Done means the analytics asset is generated and uploaded automatically without manual git changes, and the process works in a build environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.