trek 0.1.27 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53eb1b618fd47d1aaba94f028d33ff91a4ae1361184149f0ac51a3530392d5db
-  data.tar.gz: 772ce6d84a6f4e05eec679089a7428049119b2c178f930a5e9934424d2465717
+  metadata.gz: ae0f648a6ca1125a784ae4d052017885274c6b8856eeba469b59eba1e5af8809
+  data.tar.gz: cfe7b5cf820ed4a86d519217d1f4d5a226f8a76a90edbb247d2eca9ec69c9a15
 SHA512:
-  metadata.gz: 4f866c4a665ed0cdd1101385a86edf1264b07b5810e41c5e48399ede3bb25e95912f5b8a0c1153089361b61f4aa535bbced16f2f30d4724a53f78c75bf747faf
-  data.tar.gz: 6f9ad9c66a64db021d848dadaf8d6c485497d1e6b49683c01d09623a4c0640a46ce9b2493c5bf2864fd43ebea13f1cef12ce617b10268be516d63e670cd8716e
+  metadata.gz: b7bba7c7c0afc04dcbcd2413395977cf9521ef35ae433a2799292d3ae3525cb2d5a27f3d5a99c726145e5b2890455302c620adbd8405b823cca00eddeb46b721
+  data.tar.gz: 06e1be7336b7c5464d9cbcc0beffadba2a20c742fe40735f06c7cced96a28b326d1ec08f3ebc1581dc31b2e6761f3d7d617c69a96b72ef0b921b35ceb1f18b4b

data/.yarnrc.yml

@@ -1,11 +1,5 @@
 nodeLinker: node-modules
 
-npmScopes:
-  etaminstudio:
-    npmAlwaysAuth: true
-    npmAuthToken: "${NPM_AUTH_TOKEN-fallback}"
-    npmPublishRegistry: "https://git.etamin.studio/api/v4/projects/229/packages/npm/"
-
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
     spec: "@yarnpkg/plugin-interactive-tools"

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [2.0.0] - 2026-08-18
+
+### Changed
+
+- Trek's packages are now **public-only** (#197): the gem is consumed from [RubyGems](https://rubygems.org/gems/trek) and the npm package — renamed from `@etaminstudio/trek` to the unscoped [`trek`](https://www.npmjs.com/package/trek) — is published to npmjs.com. Nothing is published to the private GitLab registries any more, and no deploy token is needed. Because the previous owner of the npm `trek` name had already published versions up to `1.0.0` (npm never frees version numbers), Trek jumps straight to **2.0.0**, keeping gem and npm versions in lockstep. **Upgrade note:** existing apps upgrade by moving to 0.1.27 first, then running `rails g trek:upgrade:v2` (see 0.1.27's changelog entry) — the generator now also adds the `npmPreapprovedPackages` exemption below. Afterwards, remove the now-unneeded CI variables — `NPM_AUTH_TOKEN` and `BUNDLE_GIT__ETAMIN__STUDIO` (spelled `BUNDLE_GIT__ETAMINSTUD__IO` on apps created before the domain migration) — along with any local `TREK_DEPLOY_TOKEN` export, and revoke the project's Trek deploy token on GitLab.
+- `trek:install` now wires new apps to the public packages: the generated `package.json` depends on `trek`, the JS entrypoint imports `"trek"`, and the generated `.yarnrc.yml` no longer configures the GitLab registry/scope — instead it lists `trek` under `npmPreapprovedPackages`, exempting it from Yarn's package gates (minimal age, …) so fresh releases install without the quarantine delay.
+- The published npm tarball now only contains what host apps consume — `app/javascript`, `app/assets/{icons,images,stylesheets}` and the components' JS/CSS sidecars — instead of the whole repository (Ruby engine code, specs, docs, local config…).
+- Package metadata refresh for the public listings: description "A modern content management & back-office system for Ruby on Rails" and homepage <https://trek.etamin.studio> on both the gemspec and `package.json`, plus an explicit MIT license on both.
+- `make release` now publishes the npm package with `npm publish` (requires `npm login` as a `trek` maintainer) instead of `yarn npm publish` to the GitLab registry.
+
 ## [0.1.27] - 2026-08-18
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trek (0.1.27)
+    trek (2.0.0)
       action_policy (~> 0.6)
       actioncable
       acts_as_list (~> 1.1)

data/Makefile

@@ -10,7 +10,7 @@ release:
 	git add -A; \
 	git commit -m "Version $$version"; \
 	bundle exec rake release; \
-	yarn npm publish
+	npm publish
 
 audit-fix:
 	@out=$$(bundle exec bundle-audit check --update 2>&1); \

data/README.md

@@ -7,8 +7,8 @@ Trek is a modern content management system for Ruby on Rails, that is designed t
 - Rails 7.0+
 - Ruby 3.1+
 - PostgreSQL 12+
-- Node 20+
-- Yarn 3.x
+- Node 22+
+- Yarn 4.x
 - libvips
 
 ### Dependencies
@@ -32,19 +32,19 @@ You don't have to set them up yourself, but you can customize their configuratio
 Make sure your default Rails version is 7.0+
 
     $ rails -v
-    Rails 7.1.3
+    Rails 8.1.3
 
 If not, run `gem install rails` to upgrade.
 
-Make sure your default Yarn version is 3.x
+Make sure your default Yarn version is 4.x
 
     $ yarn -v
-    3.8.0
+    4.17.0
 
 If not, run:
 
     corepack enable
-    corepack install --global yarn@3
+    corepack install --global yarn@4
 
 Create your Rails project (replace `helloworld` with your own project name):
 
@@ -52,31 +52,11 @@ Create your Rails project (replace `helloworld` with your own project name):
     rails new $TREK_PROJECT_NAME -j esbuild -d postgresql --skip-action-mailbox --skip-action-text --skip-action-cable --skip-active-storage --skip-jbuilder --skip-test --skip-system-test
     cd $TREK_PROJECT_NAME
 
-[Create a deploy token](https://git.etamin.studio/etaminstudio/trek/-/settings/repository#js-deploy-tokens) associated to Trek project:
-
-- Name: `helloworld` (replace with your project name)
-- Username: `helloworld` (replace with your project name)
-- Scopes: `read_repository`, `read_package_registry`
-
-Copy the generated token to an ENV variable (replace `XXXXXXXXXXX` with the token generated by Gitlab):
-
-    export TREK_DEPLOY_TOKEN=XXXXXXXXXXX
-
 ### Install the gem
 
-Add this deploy token to your project local config:
-
-    bundle config git.etamin.studio $TREK_PROJECT_NAME:$TREK_DEPLOY_TOKEN
-
-Install the gem and add it to the application's Gemfile by running:
-
-    bundle add trek --git https://git.etamin.studio/etaminstudio/trek.git --branch main
+Trek is distributed publicly: the gem on [RubyGems](https://rubygems.org/gems/trek) and the [`trek` npm package](https://www.npmjs.com/package/trek) on npmjs.com (the installer adds the latter to your `package.json`). Install the gem and add it to the application's Gemfile by running:
 
-### Install the NPM package
-
-Prepare the NPM package installation by running:
-
-    export NPM_AUTH_TOKEN=$TREK_DEPLOY_TOKEN
+    bundle add trek
 
 ### Run the installer
 
@@ -134,8 +114,8 @@ The title and subtitle are customizable in the locales, with the following keys:
 en:
   admin:
     brand:
-        title: My project
-        subtitle: Back-office
+      title: My project
+      subtitle: Back-office
 ```
 
 ### Useful commands
@@ -146,18 +126,6 @@ Customize the credentials with `ADMIN_EMAIL` and `ADMIN_PASSWORD` ENV variables
 
     rails g trek:admin:user
 
-## CI setup
-
-### Gitlab
-
-Once your project is created on Gitlab, go to `Settings` > `CI/CD` > `Variables` > `Add variable` and use these values:
-
-- Key: `BUNDLE_GIT__ETAMINSTUD__IO`
-- Value: `helloworld:YOUR_DEPLOY_TOKEN` (replace with your project name)
-
-- Key: `NPM_AUTH_TOKEN`
-- Value: `YOUR_DEPLOY_TOKEN`
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -196,7 +164,7 @@ When you're done, disable the local version:
 
 Don't forget to revert to a released verion in your `Gemfile`:
 
-    gem "trek", "~> 0.1"
+    gem "trek", "~> 2.0"
 
 #### Linking to the local NPM package with Yarn
 
@@ -229,4 +197,4 @@ This will:
 3. Run `bundle` to update the lockfile
 4. Commit all changes with message "Version X.Y.Z"
 5. Run `bundle exec rake release` (creates git tag, pushes commits/tag, pushes gem to [rubygems.org](https://rubygems.org))
-6. Run `yarn npm publish` (publishes the npm package). This requires a [personal token](https://git.etamin.studio/-/user_settings/personal_access_tokens) with the `api` scope to be present in `NPM_AUTH_TOKEN`,
+6. Run `npm publish` (publishes the [npm package](https://www.npmjs.com/package/trek) to npmjs.com). This requires being logged in to npmjs (`npm login`) as a maintainer of the `trek` package.

data/docs/getting-started.md

@@ -9,8 +9,8 @@ Make sure the following are installed:
 - Ruby 3.1+
 - Rails 7.0+
 - PostgreSQL 12+
-- Node 20+
-- Yarn 3.x
+- Node 22+
+- Yarn 4.x
 - libvips
 
 Check your Rails version:
@@ -27,11 +27,11 @@ Check your Yarn version:
 yarn -v
 ```
 
-If it's not a 3.x version, run:
+If it's not a 4.x version, run:
 
 ```sh
 corepack enable
-corepack install --global yarn@3
+corepack install --global yarn@4
 ```
 
 ## Create your Rails project
@@ -46,38 +46,12 @@ rails new $TREK_PROJECT_NAME -j esbuild -d postgresql \
 cd $TREK_PROJECT_NAME
 ```
 
-## Get access to Trek
-
-Trek is distributed as a gem and an NPM package from Etamin Studio's GitLab. [Create a deploy token](https://git.etamin.studio/etaminstudio/trek/-/settings/repository#js-deploy-tokens) associated to the Trek project:
-
-- **Name**: your project name (e.g. `helloworld`)
-- **Username**: your project name (e.g. `helloworld`)
-- **Scopes**: `read_repository`, `read_package_registry`
-
-Export the generated token (replace `XXXXXXXXXXX`):
-
-```sh
-export TREK_DEPLOY_TOKEN=XXXXXXXXXXX
-```
-
 ## Install the gem
 
-Add the deploy token to your project's local Bundler config:
-
-```sh
-bundle config git.etamin.studio $TREK_PROJECT_NAME:$TREK_DEPLOY_TOKEN
-```
-
-Install the gem and add it to your `Gemfile`:
-
-```sh
-bundle add trek --git https://git.etamin.studio/etaminstudio/trek.git --branch main
-```
-
-Prepare the NPM package installation:
+Trek is distributed publicly: the gem on [RubyGems](https://rubygems.org/gems/trek) and the [`trek` npm package](https://www.npmjs.com/package/trek) on npmjs.com (the installer adds the latter to your `package.json`). Install the gem and add it to your `Gemfile`:
 
 ```sh
-export NPM_AUTH_TOKEN=$TREK_DEPLOY_TOKEN
+bundle add trek
 ```
 
 ## Run the installer

data/lib/generators/trek/install/assets_generator.rb

@@ -14,7 +14,7 @@ module Trek
         def add_admin_js
           create_file "app/javascript/admin.js",
             <<~JS
-              import "@etaminstudio/trek";
+              import "trek";
             JS
         end
 

data/lib/generators/trek/install/yarn_generator.rb

@@ -55,17 +55,11 @@ module Trek
           <<~YAML
             nodeLinker: node-modules
 
-            npmRegistries:
-              //git.etamin.studio/api/v4/packages/npm:
-                npmAlwaysAuth: true
-                npmAuthToken: "${NPM_AUTH_TOKEN-fallback}"
-
-            npmScopes:
-              etaminstudio:
-                npmRegistryServer: "https://git.etamin.studio/api/v4/packages/npm"
-                # Our own registry — skip Yarn's minimal-age gate so a freshly
-                # published Trek release installs without the quarantine delay.
-                npmMinimalAgeGate: 0
+            # Trek is our own package — exempt it from Yarn's package gates
+            # (minimal age, …) so a freshly published release installs without
+            # the quarantine delay.
+            npmPreapprovedPackages:
+              - trek
           YAML
         end
 

data/lib/generators/trek/templates/AGENTS.md

@@ -27,10 +27,10 @@ This is a Ruby on Rails application whose back-office/admin is built with **Trek
 
 ## Upgrading Trek
 
-**Whenever you bump the `trek` gem — and its companion `@etaminstudio/trek` npm package — always:**
+**Whenever you bump the `trek` gem — and its companion `trek` npm package — always:**
 
 1. **Read Trek's `CHANGELOG.md`** for every version between the installed and target version, not just the latest.
 2. **Apply every "Upgrade note".** These are the manual steps host apps must perform (config tweaks, new initializers, regenerated files, data migrations). Do not skip them — the upgrade is not complete until each is applied.
 3. **Remove now-redundant local code.** Where the changelog says a Trek change lets host apps drop or simplify a local patch, monkey-patch, or custom implementation, delete that code as part of the upgrade.
-4. **Keep versions aligned**: the `trek` gem version and the `@etaminstudio/trek` npm version must match.
+4. **Keep versions aligned**: the `trek` gem version and the `trek` npm version must match.
 5. **Verify**: run `make lint` and `make test` before committing the upgrade.

data/lib/generators/trek/templates/package.json.tt

@@ -2,9 +2,9 @@
   "name": "<%= application_name.downcase %>",
   "private": true,
   "dependencies": {
-    "@etaminstudio/trek": "^<%= Trek::VERSION %>",
     "@hotwired/stimulus": "^3.2.2",
-    "@hotwired/turbo-rails": "^8.0.0"
+    "@hotwired/turbo-rails": "^8.0.0",
+    "trek": "^<%= Trek::VERSION %>"
   },
   "scripts": {
     "build": "node esbuild.config.js"

data/lib/generators/trek/upgrade/v2_generator.rb

@@ -66,6 +66,20 @@ module Trek
             "and the etaminstudio scope manually.", :yellow
         end
 
+        def preapprove_npm_package
+          return unless File.exist?(".yarnrc.yml")
+          return if File.read(".yarnrc.yml").include?("npmPreapprovedPackages")
+
+          append_to_file ".yarnrc.yml", <<~YAML
+
+            # Trek is our own package — exempt it from Yarn's package gates
+            # (minimal age, …) so a freshly published release installs without
+            # the quarantine delay.
+            npmPreapprovedPackages:
+              - trek
+          YAML
+        end
+
         def install_npm_package
           install_npm_dependencies({ "trek" => NPM_REQUIREMENT })
         end
@@ -77,8 +91,11 @@ module Trek
 
             Manual follow-ups:
               * Remove the NPM_AUTH_TOKEN variable and the Bundler credentials for
-                git.etamin.studio (BUNDLE_GIT__ETAMIN__STUDIO) from your CI settings.
-              * Once every app is migrated, revoke the Trek deploy token on GitLab.
+                git.etamin.studio (BUNDLE_GIT__ETAMIN__STUDIO — spelled
+                BUNDLE_GIT__ETAMINSTUD__IO on apps created before the domain
+                migration) from your CI settings, and drop any local
+                TREK_DEPLOY_TOKEN export.
+              * Revoke this project's Trek deploy token on GitLab.
           SUMMARY
         end
       end

data/lib/trek/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trek
-  VERSION = "0.1.27"
+  VERSION = "2.0.0"
 end

data/package.json

@@ -1,8 +1,18 @@
 {
-  "name": "@etaminstudio/trek",
-  "version": "0.1.27",
-  "description": "A modern CMS for Ruby on Rails",
+  "name": "trek",
+  "version": "2.0.0",
+  "description": "A modern content management & back-office system for Ruby on Rails",
+  "homepage": "https://trek.etamin.studio",
+  "license": "MIT",
   "main": "app/javascript/trek.js",
+  "files": [
+    "app/assets/icons/**",
+    "app/assets/images/**",
+    "app/assets/stylesheets/**",
+    "app/components/**/*.js",
+    "app/components/**/*.css",
+    "app/javascript/**"
+  ],
   "repository": {
     "type": "git",
     "url": "git@git.etamin.studio:etaminstudio/trek.git"

data/trek.gemspec

@@ -8,13 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors = ["Mohamed Bengrich", "Hugo Chantelauze", "Lucas Heymès", "Hans Lemuet"]
   spec.email = ["team@etamin.studio"]
 
-  spec.summary = "A modern CMS for Ruby on Rails"
-  spec.homepage = "https://etamin.studio"
+  spec.summary = "A modern content management & back-office system for Ruby on Rails"
+  spec.homepage = "https://trek.etamin.studio"
+  spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["documentation_uri"] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/yarn.lock

@@ -877,52 +877,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@etaminstudio/trek@workspace:.":
-  version: 0.0.0-use.local
-  resolution: "@etaminstudio/trek@workspace:."
-  dependencies:
-    "@hotwired/stimulus": ^3.2.2
-    "@hotwired/turbo-rails": ^8.0.20
-    "@radix-ui/colors": ^3.0.0
-    "@tiptap/core": ^2.1.11
-    "@tiptap/extension-floating-menu": ^2.1.11
-    "@tiptap/extension-link": ^2.1.11
-    "@tiptap/extension-placeholder": ^2.1.11
-    "@tiptap/pm": ^2.1.11
-    "@tiptap/starter-kit": ^2.1.11
-    "@uppy/core": ^3.0.4
-    "@uppy/locales": ^3.0.1
-    "@uppy/thumbnail-generator": ^3.0.2
-    "@uppy/xhr-upload": ^3.0.4
-    esbuild: ^0.28.0
-    esbuild-rails: ^1.0.7
-    esbuild-style-plugin: ^1.6.3
-    eslint: ^8.49.0
-    eslint-config-prettier: ^8.10.2
-    hotkeys-js: ^3.13.15
-    normalize.css: ^8.0.1
-    postcss: ^8.4.30
-    postcss-cli: ^10.1.0
-    postcss-flexbugs-fixes: ^5.0.2
-    postcss-import: ^15.1.0
-    postcss-inline-svg: ^5.0.0
-    postcss-modules: ^5.0.0
-    postcss-nesting: ^10.2.0
-    postcss-preset-env: ^7.8.3
-    postcss-url: ^10.1.3
-    prettier: 2.8.8
-    slugify: ^1.6.6
-    sortablejs: ^1.15.6
-    stimulus-use: ^0.52.3
-    stylelint: ^15.11.0
-    stylelint-config-standard: ^31.0.0
-    stylelint-order: ^6.0.4
-    tom-select: ^2.2.2
-    vitepress: ^1.6.4
-    vitepress-plugin-llms: ^1.13.1
-  languageName: unknown
-  linkType: soft
-
 "@hotwired/stimulus@npm:^3.2.2":
   version: 3.2.2
   resolution: "@hotwired/stimulus@npm:3.2.2"
@@ -6653,6 +6607,52 @@ __metadata:
   languageName: node
   linkType: hard
 
+"trek@workspace:.":
+  version: 0.0.0-use.local
+  resolution: "trek@workspace:."
+  dependencies:
+    "@hotwired/stimulus": ^3.2.2
+    "@hotwired/turbo-rails": ^8.0.20
+    "@radix-ui/colors": ^3.0.0
+    "@tiptap/core": ^2.1.11
+    "@tiptap/extension-floating-menu": ^2.1.11
+    "@tiptap/extension-link": ^2.1.11
+    "@tiptap/extension-placeholder": ^2.1.11
+    "@tiptap/pm": ^2.1.11
+    "@tiptap/starter-kit": ^2.1.11
+    "@uppy/core": ^3.0.4
+    "@uppy/locales": ^3.0.1
+    "@uppy/thumbnail-generator": ^3.0.2
+    "@uppy/xhr-upload": ^3.0.4
+    esbuild: ^0.28.0
+    esbuild-rails: ^1.0.7
+    esbuild-style-plugin: ^1.6.3
+    eslint: ^8.49.0
+    eslint-config-prettier: ^8.10.2
+    hotkeys-js: ^3.13.15
+    normalize.css: ^8.0.1
+    postcss: ^8.4.30
+    postcss-cli: ^10.1.0
+    postcss-flexbugs-fixes: ^5.0.2
+    postcss-import: ^15.1.0
+    postcss-inline-svg: ^5.0.0
+    postcss-modules: ^5.0.0
+    postcss-nesting: ^10.2.0
+    postcss-preset-env: ^7.8.3
+    postcss-url: ^10.1.3
+    prettier: 2.8.8
+    slugify: ^1.6.6
+    sortablejs: ^1.15.6
+    stimulus-use: ^0.52.3
+    stylelint: ^15.11.0
+    stylelint-config-standard: ^31.0.0
+    stylelint-order: ^6.0.4
+    tom-select: ^2.2.2
+    vitepress: ^1.6.4
+    vitepress-plugin-llms: ^1.13.1
+  languageName: unknown
+  linkType: soft
+
 "trim-lines@npm:^3.0.0":
   version: 3.0.1
   resolution: "trim-lines@npm:3.0.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trek
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 2.0.0
 platform: ruby
 authors:
 - Mohamed Bengrich
@@ -951,10 +951,12 @@ files:
 - trek.gemspec
 - vendor/tom_select/css/tom-select.custom.css
 - yarn.lock
-homepage: https://etamin.studio
-licenses: []
+homepage: https://trek.etamin.studio
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://etamin.studio
+  homepage_uri: https://trek.etamin.studio
+  documentation_uri: https://trek.etamin.studio
 rdoc_options: []
 require_paths:
 - lib
@@ -971,5 +973,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.16
 specification_version: 4
-summary: A modern CMS for Ruby on Rails
+summary: A modern content management & back-office system for Ruby on Rails
 test_files: []