feat: publishing workflow

refactor: update changelog v3.0.0-next.0
2026-01-05 13:02:54 +00:00 · 2023-06-30 13:14:27 +02:00
parent 0a7e6af141
commit 4e4c7b5cc9
56 changed files with 2456 additions and 192 deletions
--- a/backend/backend/.gitlab-ci.yml
+++ b/backend/backend/.gitlab-ci.yml
@@ -19,4 +19,4 @@ integration:
      junit:
        - backend/backend/coverage/integration-report-junit.xml
  rules:
-    - when: on_success
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event' || $CI_COMMIT_BRANCH == 'main' || $CI_COMMIT_BRANCH == 'develop' || $CI_COMMIT_TAG
--- a/backend/backend/CHANGELOG.md
+++ b/backend/backend/CHANGELOG.md
@@ -1,5 +1,155 @@
 # @openstapps/backend

+## 3.0.0-next.0
+
+### Major Changes
+
+- 64caebaf: Migrate config system to cosmiconfig
+
+  Configs are now written using type-checked JavaScript
+
+  ```js
+  // @ts-check
+
+  // This file is now type-safe just like TypeScript, but
+  // without the compilation step
+
+  /** @type {import('@openstapps/package').Type} */
+  const foo = {};
+  ```
+
+  You can write config files in JavaScript, JSON, or other
+  cosmiconfig-supported formats.
+
+  The config files now are
+
+  - `backendrc.{js,json,...}`
+  - `elasticsearchrc.{js,json,...}`
+  - `prometheusrc.{js,json,...}`
+
+  You can also split them into multiple files,
+  as well as using the `markdown.js` helper in
+  `config/default/tools` to include markdown files
+  as text (see `config/f-u/about-pages`)
+
+- 64caebaf: Move project to a turbo monorepo & pnpm
+
+  Internal dependencies are now defined using `"@openstapps/package": "workspace:*"`
+
+  - Removed extraneous files from packages
+    - `.npmrc`
+    - `.npmignore`
+    - `.mailmap`
+    - `.gitignore`
+    - `CONTRIBUTING.md`
+    - `LICENSE` (Project license file is added upon publishing, see [pnpm.io](https://pnpm.io/cli/publish))
+    - `package-lock.json`
+    - `.editorconfig`
+    - `.eslintrc.json` (moved eslint config to `package.json`)
+    - `.eslintignore`
+    - `.gitlab-ci.yml` (Most workflows are workspace-level)
+    - `.gitlab/**` (issue templates etc. are now workspace-level)
+    - `.dockerignore` (Docker files are determined by which files are deployed with `pnpm deploy`, as per `package.json/files`)
+  - TSConfig has been moved to its own package (You can now use `"extends": "@openstapps/tsconfig"`)
+  - Removed ESLint and Prettier peer dependency hell by injecting them through the `.pnpmfile.cjs`
+  - Added syncpack for keeping dependency versions in sync (and consistent key ordering in `package.json`)
+  - Replaced conventional changelog with changesets
+  - Apps with binaries now use a top level `app.js`
+
+  ```js
+  #!/usr/bin/env node
+  import './lib/app.js';
+  ```
+
+- 64caebaf: Migrate to ESM
+
+  CommonJS is no longer supported in any capacity. To use the new
+  version, you will need to migrate your package to ESM.
+  We recommend using `tsup` and `Node 18`.
+
+  ```json
+  {
+    "type": "module"
+  }
+  ```
+
+- 64caebaf: Migrate package to Node 18
+
+  - Consumers of this package will need to migrate to Node 18 or
+    higher.
+  - Packages have been migrated from promisified `readFile` or
+    `readFileSync` towards `fs/promises`
+  - Packages use native `flatMap` now
+
+- 0a7e6af1: Migrate es mapping types from es-mapping-generator to .d.ts next to generated mappings
+- 64caebaf: Migrate build system to `tsup`
+
+  All packages now use an `index.ts` file to expose contents.
+
+  You will need to migrate paths from `import foo from '@scope/package/lib/foo` to `import foo from '@scope/package'`
+
+### Minor Changes
+
+- 64caebaf: Migrate integration tests from docker-compose solution to a shell script
+
+  `api-cli` no longer builds as a Docker container as a result.
+
+- 64caebaf: Migrate tests to C8/Chai/Mocha
+
+  - `@testdeck` OOP testing has been removed.
+  - Tests have been unified
+  - CommonJS module mocking has been replaced through
+    refactoring of tests, as ES Modules cannot be mocked
+    (do yourself a favor and don't try to mock them)
+  - C8 now replaces NYC as a native coverage tool
+
+- 64caebaf: Migrate away from `@krlwlfrt/async-pool`
+
+  ```ts
+  import {mapAsyncLimit} from '@openstapps/collection-utils';
+
+  await mapAsyncLimit(
+    [1, 2, 3],
+    async it => {
+      await someNetworkRequest(it);
+    },
+    5,
+  );
+  ```
+
+### Patch Changes
+
+- 64caebaf: Migrated changelogs to changeset format
+
+  ```js
+  import fs from 'fs';
+
+  const path = 'packages/logger/CHANGELOG.md';
+
+  fs.writeFileSync(path, fs.readFileSync(path, 'utf8').replace(/^#+\s+\[/gm, '## ['));
+  ```
+
+- 98546a97: Migrate away from @openstapps/configuration
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [0a7e6af1]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+  - @openstapps/core-tools@3.0.0-next.0
+  - @openstapps/logger@3.0.0-next.0
+  - @openstapps/core@3.0.0-next.0
+
 ## [1.0.0](https://gitlab.com/openstapps/backend/compare/v0.6.0...v1.0.0) (2023-05-08)

 ### Bug Fixes
--- a/backend/backend/package.json
+++ b/backend/backend/package.json
@@ -1,7 +1,8 @@
 {
  "name": "@openstapps/backend",
  "description": "A reference implementation for a StApps backend",
-  "version": "2.0.0",
+  "version": "3.0.0-next.0",
+  "private": true,
  "type": "module",
  "license": "AGPL-3.0-only",
  "author": "André Bierlein <andre.mt.bierlein@gmail.com>",
@@ -23,14 +24,15 @@
    "config",
    "Dockerfile",
    "README.md",
-    "ROUTES.md"
+    "ROUTES.md",
+    "CHANGELOG.md"
  ],
  "scripts": {
    "build": "tsup-node",
    "build:docker": "docker build -t openstapps:backend ../../.deploy/backend",
    "deploy": "pnpm --prod --filter=@openstapps/backend deploy ../../.deploy/backend",
    "dev": "tsup --watch --onSuccess \"pnpm run start\"",
-    "docs": "openapi build-docs ./node_modules/@openstapps/core/lib/openapi.json -o docs/openapi/index.html",
+    "docs:disabled": "openapi build-docs --file ./node_modules/@openstapps/core/lib/openapi.json --output-dir docs/openapi",
    "format": "prettier . -c --ignore-path ../../.gitignore",
    "format:fix": "prettier --write . --ignore-path ../../.gitignore",
    "lint": "tsc --noEmit && eslint --ext .ts src/",
--- a/backend/database/package.json
+++ b/backend/database/package.json
@@ -1,5 +1,10 @@
 {
  "name": "@openstapps/database",
  "version": "2.0.0",
-  "private": true
+  "private": true,
+  "files": [
+    "config",
+    "Dockerfile",
+    "README.md"
+  ]
 }
--- a/backend/proxy/CHANGELOG.md
+++ b/backend/proxy/CHANGELOG.md
@@ -1,5 +1,99 @@
 # @openstapps/proxy

+## 3.0.0-next.0
+
+### Major Changes
+
+- 64caebaf: Move project to a turbo monorepo & pnpm
+
+  Internal dependencies are now defined using `"@openstapps/package": "workspace:*"`
+
+  - Removed extraneous files from packages
+    - `.npmrc`
+    - `.npmignore`
+    - `.mailmap`
+    - `.gitignore`
+    - `CONTRIBUTING.md`
+    - `LICENSE` (Project license file is added upon publishing, see [pnpm.io](https://pnpm.io/cli/publish))
+    - `package-lock.json`
+    - `.editorconfig`
+    - `.eslintrc.json` (moved eslint config to `package.json`)
+    - `.eslintignore`
+    - `.gitlab-ci.yml` (Most workflows are workspace-level)
+    - `.gitlab/**` (issue templates etc. are now workspace-level)
+    - `.dockerignore` (Docker files are determined by which files are deployed with `pnpm deploy`, as per `package.json/files`)
+  - TSConfig has been moved to its own package (You can now use `"extends": "@openstapps/tsconfig"`)
+  - Removed ESLint and Prettier peer dependency hell by injecting them through the `.pnpmfile.cjs`
+  - Added syncpack for keeping dependency versions in sync (and consistent key ordering in `package.json`)
+  - Replaced conventional changelog with changesets
+  - Apps with binaries now use a top level `app.js`
+
+  ```js
+  #!/usr/bin/env node
+  import './lib/app.js';
+  ```
+
+- 64caebaf: Migrate to ESM
+
+  CommonJS is no longer supported in any capacity. To use the new
+  version, you will need to migrate your package to ESM.
+  We recommend using `tsup` and `Node 18`.
+
+  ```json
+  {
+    "type": "module"
+  }
+  ```
+
+- 64caebaf: Migrate package to Node 18
+
+  - Consumers of this package will need to migrate to Node 18 or
+    higher.
+  - Packages have been migrated from promisified `readFile` or
+    `readFileSync` towards `fs/promises`
+  - Packages use native `flatMap` now
+
+- 64caebaf: Migrate build system to `tsup`
+
+  All packages now use an `index.ts` file to expose contents.
+
+  You will need to migrate paths from `import foo from '@scope/package/lib/foo` to `import foo from '@scope/package'`
+
+### Minor Changes
+
+- 64caebaf: Migrate tests to C8/Chai/Mocha
+
+  - `@testdeck` OOP testing has been removed.
+  - Tests have been unified
+  - CommonJS module mocking has been replaced through
+    refactoring of tests, as ES Modules cannot be mocked
+    (do yourself a favor and don't try to mock them)
+  - C8 now replaces NYC as a native coverage tool
+
+### Patch Changes
+
+- 64caebaf: Migrated changelogs to changeset format
+
+  ```js
+  import fs from 'fs';
+
+  const path = 'packages/logger/CHANGELOG.md';
+
+  fs.writeFileSync(path, fs.readFileSync(path, 'utf8').replace(/^#+\s+\[/gm, '## ['));
+  ```
+
+- 98546a97: Migrate away from @openstapps/configuration
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+  - @openstapps/logger@3.0.0-next.0
+
 ## [1.5.1](https://gitlab.com/openstapps/proxy/compare/v1.5.0...v1.5.1) (2023-01-16)

 ## [1.5.0](https://gitlab.com/openstapps/proxy/compare/v1.4.1...v1.5.0) (2022-11-29)
--- a/backend/proxy/package.json
+++ b/backend/proxy/package.json
@@ -1,7 +1,7 @@
 {
  "name": "@openstapps/proxy",
  "description": "NGINX proxy that is dynamically configured by a Node.js script",
-  "version": "2.0.0",
+  "version": "3.0.0-next.0",
  "private": true,
  "type": "module",
  "license": "AGPL-3.0-only",
@@ -27,7 +27,8 @@
    ".dockerignore",
    "nginx.conf",
    "nginx.conf.template",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
  ],
  "scripts": {
    "build": "tsup-node --dts",