From 3aab5defed382adfe24c148722097b69449876d9 Mon Sep 17 00:00:00 2001 From: Tobias Ortmayr Date: Thu, 17 Sep 2026 16:02:00 +0200 Subject: [PATCH] GLSP-1682: Add deprecation notices and disable auto-publish - Add deprecation banners to the root README, CONTRIBUTING, and all npm-visible package READMEs, pointing to the new home of each package in the consolidated `glsp-core` monorepo - Note in the workflow-server-bundled-web README that the package is private in glsp-core and will no longer be published to npm - Remove the `workflow_run` trigger from publish.yml so merges to `main` no longer publish `2.9.0-next` packages racing glsp-core; manual dispatch/call remains for emergency republishes - Mark the repository as deprecated in AGENTS.md and CLAUDE.md so agents do not implement changes here Part of: eclipse-glsp/glsp#1682 --- .github/workflows/publish.yml | 9 ++++----- AGENTS.md | 2 ++ CLAUDE.md | 2 ++ CONTRIBUTING.md | 5 +++++ README.md | 6 ++++++ examples/workflow-server-bundled-web/README.md | 5 +++++ examples/workflow-server-bundled/README.md | 4 ++++ examples/workflow-server-mcp-demo/README.md | 4 ++++ examples/workflow-server/README.md | 4 ++++ packages/graph/README.md | 4 ++++ packages/layout-elk/README.md | 4 ++++ packages/server-mcp/README.md | 4 ++++ packages/server/README.md | 4 ++++ 13 files changed, 52 insertions(+), 5 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fe705afd..99f7e154 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,11 +1,10 @@ name: 'Publish to NPM' +# This repository is deprecated. Starting with version 2.9.0 all packages are developed and +# published from the consolidated `glsp-core` monorepo (https://github.com/eclipse-glsp/glsp-core). +# The automatic `workflow_run` trigger (nightly publish on successful CI of `main`) has therefore +# been removed. Only manual dispatch/call remains, for emergency republishing of old versions. on: - workflow_run: - workflows: ['CI'] - types: - - completed - branches: [main] workflow_call: inputs: ref: diff --git a/AGENTS.md b/AGENTS.md index bc06c014..ae5b1141 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,7 @@ # AGENTS.md +> **This repository is deprecated and will be archived.** Active development happens in the [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo — do not implement changes here. + ## Project Overview Eclipse GLSP Server Node monorepo. Provides the TypeScript-based server framework for the Graphical Language Server Platform (GLSP). Contains core server packages, graph model, ELK layout integration, and example workflow server. Uses pnpm workspaces. diff --git a/CLAUDE.md b/CLAUDE.md index f8cb018b..a41a342e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,5 +1,7 @@ # CLAUDE.md +> **This repository is deprecated and will be archived.** Active development happens in the [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo — do not implement changes here. + ## Project Overview Eclipse GLSP Server Node monorepo. Provides the TypeScript-based server framework for the Graphical Language Server Platform (GLSP). Contains core server packages, graph model, ELK layout integration, and example workflow server. Uses pnpm workspaces. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42782e70..bfac5651 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,10 @@ # Contributing to Eclipse GLSP +> [!IMPORTANT] +> This repository is deprecated and will be archived soon. Please contribute to the consolidated +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo instead and follow its +> [CONTRIBUTING.md](https://github.com/eclipse-glsp/glsp-core/blob/main/CONTRIBUTING.md). + Thank you for your interest in the GLSP project! The following is a set of guidelines for contributing to GLSP. ## Code of Conduct diff --git a/README.md b/README.md index 1de7418d..c7c6d27b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # GLSP Server [![Build Status](https://img.shields.io/github/actions/workflow/status/eclipse-glsp/glsp-server-node/ci.yml?branch=main&label=build)](https://github.com/eclipse-glsp/glsp-server-node/actions/workflows/ci.yml) +> [!IMPORTANT] +> **This repository is deprecated and will be archived soon.** +> Development has moved to the consolidated [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo. +> Starting with version `2.9.0`, all packages of this repository are developed and published from there. +> Please report issues in the [GLSP umbrella repository](https://github.com/eclipse-glsp/glsp/issues) and open pull requests against `glsp-core`. + Contains the code for the Typescript-based framework to create [GLSP](https://github.com/eclipse-glsp/glsp) server components. The implementation of this server is aligned with the default Java based [GLSP Server](https://github.com/eclipse-glsp/glsp-server-node). diff --git a/examples/workflow-server-bundled-web/README.md b/examples/workflow-server-bundled-web/README.md index 39710901..7997ca0b 100644 --- a/examples/workflow-server-bundled-web/README.md +++ b/examples/workflow-server-bundled-web/README.md @@ -1,5 +1,10 @@ # Eclipse GLSP - Workflow Example Server (bundled, web) +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`examples/workflow-server-bundled-web`). This repository is deprecated and will be archived. +> In `glsp-core` this package is private and will no longer be published to npm. + Provides a bundled version of the Workflow example server for web (webworker). This example server is used as dev example in GLSP projects. Note that this package provides the bundled file. If you are looking for the unbundled source code with type definitions check out [`@eclipse-glsp-examples/workflow-server`](https://www.npmjs.com/package/@eclipse-glsp-examples/workflow-server). diff --git a/examples/workflow-server-bundled/README.md b/examples/workflow-server-bundled/README.md index 05404c32..c4ecdf9b 100644 --- a/examples/workflow-server-bundled/README.md +++ b/examples/workflow-server-bundled/README.md @@ -1,5 +1,9 @@ # Eclipse GLSP - Workflow Example Server (bundled) +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`examples/workflow-server-bundled`). This repository is deprecated and will be archived. + Provides a bundled version of the Workflow example server for node. This example server is used as dev example in GLSP projects. Note that this package provides the bundled file. If you are looking for the unbundled source code with type definitions check out [`@eclipse-glsp-examples/workflow-server`](https://www.npmjs.com/package/@eclipse-glsp-examples/workflow-server). diff --git a/examples/workflow-server-mcp-demo/README.md b/examples/workflow-server-mcp-demo/README.md index 713cd984..656a8c17 100644 --- a/examples/workflow-server-mcp-demo/README.md +++ b/examples/workflow-server-mcp-demo/README.md @@ -1,5 +1,9 @@ # Workflow Server MCP Demo (browser) +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`examples/workflow-server-mcp-demo`). This repository is deprecated and will be archived. + A browser demo for the `@eclipse-glsp/server-mcp` portable Fetch handler. The page opens a workflow GLSP session inside an in-page Web Worker and drives the MCP server through a Service Worker that intercepts `fetch('/mcp', …)` and proxies the request to the Worker via diff --git a/examples/workflow-server/README.md b/examples/workflow-server/README.md index a9c6488b..0eed9d5f 100644 --- a/examples/workflow-server/README.md +++ b/examples/workflow-server/README.md @@ -1,5 +1,9 @@ # Eclipse GLSP - Workflow Examples +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`examples/workflow-server`). This repository is deprecated and will be archived. + Provides the typescript implementation of the Workflow example server. This example server is used as dev example in GLSP projects. ## Workflow Diagram Example diff --git a/packages/graph/README.md b/packages/graph/README.md index f0dede2e..fa822973 100644 --- a/packages/graph/README.md +++ b/packages/graph/README.md @@ -1,5 +1,9 @@ # Eclipse GLSP - Graph model +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`packages/server/graph`). This repository is deprecated and will be archived. + A typescript implementation of the [GLSP graph model](https://github.com/eclipse-glsp/glsp-server/tree/master/plugins/org.eclipse.glsp.graph). ## More information diff --git a/packages/layout-elk/README.md b/packages/layout-elk/README.md index 9244906c..45d7f410 100644 --- a/packages/layout-elk/README.md +++ b/packages/layout-elk/README.md @@ -1,5 +1,9 @@ # Eclipse GLSP - Layout ELK +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`packages/server/layout-elk`). This repository is deprecated and will be archived. + Integration of the [Eclipse Layout Kernel (ELK)](https://www.eclipse.org/elk/) with the GLSP node server framework. This packages provides an ELK layout engine that can be used for autolayouting the graphical model (GModel) on node servers. diff --git a/packages/server-mcp/README.md b/packages/server-mcp/README.md index a93e0fcd..e87c92d7 100644 --- a/packages/server-mcp/README.md +++ b/packages/server-mcp/README.md @@ -1,5 +1,9 @@ # @eclipse-glsp/server-mcp +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`packages/server/server-mcp`). This repository is deprecated and will be archived. + > **Status: Experimental.** The MCP integration is under active development. Option names, schema shapes, and handler contracts MAY change in minor releases until the feature graduates from experimental status. Pin the package version in adopter projects; track release notes for breaking changes. An extension of the [GLSP Node Server](https://github.com/eclipse-glsp/glsp-server-node) that exposes a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server alongside the existing GLSP server. This allows AI agents and LLM-based tools to interact with graphical diagram models using the standardized MCP interface. diff --git a/packages/server/README.md b/packages/server/README.md index 3414d12b..24e1638f 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -1,5 +1,9 @@ # Eclipse GLSP - Server +> [!IMPORTANT] +> Starting with version `2.9.0`, this package is developed and published from the +> [`glsp-core`](https://github.com/eclipse-glsp/glsp-core) monorepo (`packages/server/server`). This repository is deprecated and will be archived. + A typescript implementation of the Java [GLSP Server](https://github.com/eclipse-glsp/glsp-server). ## More information