Skip to content

docs: add ADR-005 regarding build process for Thermidor#7883

Open
louis-bompart wants to merge 2 commits into
mainfrom
thermidor/build-adr
Open

docs: add ADR-005 regarding build process for Thermidor#7883
louis-bompart wants to merge 2 commits into
mainfrom
thermidor/build-adr

Conversation

@louis-bompart

@louis-bompart louis-bompart commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Ink down a new architectural decision record (ADR-005) documenting the build process for the @coveo/thermidor package. The ADR formalizes the decision to distribute Thermidor as an ESM-only package, outlines the rationale behind this choice, and details the implications for consumers and contributors.

https://coveord.atlassian.net/browse/KIT-5850

@changeset-bot

changeset-bot Bot commented Jun 25, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3b3f5fa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@svcsnykcoveo

svcsnykcoveo commented Jun 25, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Thermidor architectural decision record (ADR-005) documenting the package’s build/distribution approach, focusing on an ESM-only output and the implications for consumers (especially Node.js CJS require() users).

Changes:

  • Documented the decision to publish @coveo/thermidor as ESM-only and compile via tsc into dist/.
  • Captured tradeoffs vs dual ESM/CJS packaging (incl. dual-package hazard) and outlined migration/compatibility constraints.
  • Defined runtime/operational implications and rollout guidance for consumers.

Comment thread packages/thermidor/docs/internal/adr/ADR-005-build-process.md Outdated
Comment thread packages/thermidor/docs/internal/adr/ADR-005-build-process.md Outdated
Comment thread packages/thermidor/docs/internal/adr/ADR-005-build-process.md
Comment thread packages/thermidor/docs/internal/adr/ADR-005-build-process.md
Comment thread packages/thermidor/docs/internal/adr/ADR-005-build-process.md Outdated
Comment thread packages/thermidor/docs/internal/adr/ADR-005-build-process.md
@pkg-pr-new

pkg-pr-new Bot commented Jun 25, 2026

Copy link
Copy Markdown
@coveo/atomic

npm i https://pkg.pr.new/@coveo/atomic@7883

@coveo/atomic-hosted-page

npm i https://pkg.pr.new/@coveo/atomic-hosted-page@7883

@coveo/atomic-legacy

npm i https://pkg.pr.new/@coveo/atomic-legacy@7883

@coveo/atomic-react

npm i https://pkg.pr.new/@coveo/atomic-react@7883

@coveo/auth

npm i https://pkg.pr.new/@coveo/auth@7883

@coveo/bueno

npm i https://pkg.pr.new/@coveo/bueno@7883

@coveo/create-atomic

npm i https://pkg.pr.new/@coveo/create-atomic@7883

@coveo/create-atomic-component

npm i https://pkg.pr.new/@coveo/create-atomic-component@7883

@coveo/create-atomic-component-project

npm i https://pkg.pr.new/@coveo/create-atomic-component-project@7883

@coveo/create-atomic-result-component

npm i https://pkg.pr.new/@coveo/create-atomic-result-component@7883

@coveo/create-atomic-rollup-plugin

npm i https://pkg.pr.new/@coveo/create-atomic-rollup-plugin@7883

@coveo/headless

npm i https://pkg.pr.new/@coveo/headless@7883

@coveo/headless-react

npm i https://pkg.pr.new/@coveo/headless-react@7883

@coveo/shopify

npm i https://pkg.pr.new/@coveo/shopify@7883

commit: 3b3f5fa

Co-authored-by: louis-bompart <12366410+louis-bompart@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants