chore: test action

Author: dangreen

.github/actions/simple-release/action.yaml

@@ -0,0 +1,17 @@
+name: simple-release
+description: A simple tool to release projects with monorepo support.
+inputs:
+  action:
+    description: |
+      Action that simple-release should do:
+      - pr - create pull request with release changes
+      - release - create tags, release notes and publish, only if pull request with fresh release was merged
+    default: pr
+  token:
+    description: GitHub Token
+  branch:
+    description: Branch name to store release changes
+    default: simple-release
+runs:
+  using: node20
+  main: dist/index.js

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+on:
+  push:
+    branches:
+      - action
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    name: Release
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+        # with:
+        #   fetch-depth: 0
+        #   fetch-tags: true
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 10
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Create pull request with release changes
+        run: pnpm tsm --no-warnings ./packages/github-action/src/index.ts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -23,6 +23,8 @@ node_modules
 dist
 packages/*/package
 build
+!.github/actions/*/dist
+!.github/actions/*/dist/node_modules
 
 # Env files
 .env

packages/core/package.json

@@ -60,6 +60,7 @@
   "dependencies": {
     "@conventional-changelog/git-client": "^2.4.0",
     "@simple-libs/child-process-utils": "^1.0.0",
+    "@simple-libs/hosted-git-info": "^1.0.0",
     "@simple-libs/stream-utils": "^1.0.0",
     "conventional-changelog": "^7.0.2",
     "conventional-changelog-conventionalcommits": "^9.0.0",

packages/core/src/project/monorepo.ts

@@ -51,6 +51,8 @@ export interface GenericMonorepoProjectOptions extends GenericProjectOptions {
   gitClient?: ConventionalGitClient
 }
 
+export type GenericMonorepoProjectBumpByProjectOptions = Pick<GenericProjectBumpOptions, 'version' | 'as' | 'prerelease' | 'firstRelease' | 'skip'>
+
 export interface GenericMonorepoProjectBumpOptions extends Omit<GenericProjectBumpOptions, 'tagPrefix'> {
   /**
    * Force bump projects without changes in the monorepo with fixed mode.
@@ -59,7 +61,7 @@ export interface GenericMonorepoProjectBumpOptions extends Omit<GenericProjectBu
   /**
    * Bump options for specific projects.
    */
-  byProject?: Record<string, Pick<GenericProjectBumpOptions, 'version' | 'as' | 'prerelease' | 'firstRelease'>>
+  byProject?: Record<string, GenericMonorepoProjectBumpByProjectOptions>
 }
 
 export abstract class GenericMonorepoProject extends GenericProject {

packages/core/src/project/project.ts

@@ -4,6 +4,7 @@ import { ConventionalGitClient } from '@conventional-changelog/git-client'
 import { Bumper } from 'conventional-recommended-bump'
 import { ConventionalChangelog } from 'conventional-changelog'
 import { concatStringStream } from '@simple-libs/stream-utils'
+import { parseHostedGitUrl } from '@simple-libs/hosted-git-info'
 import semver, { type ReleaseType } from 'semver'
 import {
   type ProjectManifestVersionUpdate,
@@ -63,6 +64,10 @@ export interface GenericProjectBumpOptions {
    * By default will be auto detected based on tag existence.
    */
   firstRelease?: boolean
+  /**
+   * Skip bumping.
+   */
+  skip?: boolean
   preset?: PresetParams
   /**
    * The prefix to use for the tag.
@@ -152,6 +157,17 @@ export abstract class GenericProject {
     this.gitClient = gitClient
   }
 
+  /**
+   * Get the hosted git information for the project.
+   * @returns The hosted git information.
+   */
+  async getHostedGitInfo() {
+    const remote = await this.gitClient.getConfig('remote.origin.url')
+    const info = parseHostedGitUrl(remote)
+
+    return info
+  }
+
   /**
    * Get the commit message for the version updates.
    * @returns The commit message.
@@ -249,7 +265,7 @@ export abstract class GenericProject {
       manifest
     } = this
 
-    if (await manifest.isPrivate()) {
+    if (options.skip || await manifest.isPrivate()) {
       return null
     }
 

packages/core/src/releaser.ts

@@ -10,9 +10,13 @@ import {
 import { type GenericReleaseCreator } from './release/index.js'
 import { Logger } from './logger.js'
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type GetParameter<T extends (...args: any[]) => any> = Exclude<Parameters<T>[0], undefined>
+
 export interface ReleaserOptions {
   dryRun?: boolean
   silent?: boolean
+  verbose?: boolean
   logger?: Logger
 }
 
@@ -27,13 +31,13 @@ export class Releaser<P extends GenericProject = GenericProject> {
   /**
    * The git client used to interact with the repository.
    */
-  gitClient: ConventionalGitClient
+  readonly gitClient: ConventionalGitClient
   /**
    * The logger used to log messages during the release process.
    */
-  logger: Logger
+  readonly logger: Logger
+  readonly isMonorepo: boolean
   private readonly queue: (() => Promise<unknown>)[] = []
-  private readonly isMonorepo: boolean
 
   /**
    * Creates a project releaser.
@@ -49,13 +53,18 @@ export class Releaser<P extends GenericProject = GenericProject> {
     this.isMonorepo = project instanceof GenericMonorepoProject
   }
 
+  enqueue(fn: () => Promise<void>) {
+    this.queue.push(fn)
+    return this
+  }
+
   /**
    * Enqueue a task to bump the version of the project.
    * @param options
    * @returns Project releaser instance for chaining.
    */
-  bump(options?: Omit<Parameters<P['bump']>[0], 'dryRun' | 'logger'>) {
-    this.queue.push(async () => {
+  bump(options?: Omit<GetParameter<P['bump']>, 'dryRun' | 'logger'>) {
+    return this.enqueue(async () => {
       const { isMonorepo } = this
       const { dryRun } = this.options
       const logger = this.logger.createChild('bump')
@@ -72,8 +81,6 @@ export class Releaser<P extends GenericProject = GenericProject> {
         logger.info(`No version${isMonorepo ? 's' : ''} changes detected.`)
       }
     })
-
-    return this
   }
 
   /**
@@ -82,7 +89,7 @@ export class Releaser<P extends GenericProject = GenericProject> {
    * @returns Project releaser instance for chaining.
    */
   commit(options?: ReleaserCommitOptions) {
-    this.queue.push(async () => {
+    return this.enqueue(async () => {
       const { dryRun } = this.options
 
       this.logger.info('commit', `Committing changes...`)
@@ -107,8 +114,6 @@ export class Releaser<P extends GenericProject = GenericProject> {
         await this.gitClient.commit(params)
       }
     })
-
-    return this
   }
 
   /**
@@ -117,7 +122,7 @@ export class Releaser<P extends GenericProject = GenericProject> {
    * @returns Project releaser instance for chaining.
    */
   tag(options?: ReleaserTagOptions) {
-    this.queue.push(async () => {
+    return this.enqueue(async () => {
       const { isMonorepo } = this
       const { dryRun } = this.options
 
@@ -144,8 +149,6 @@ export class Releaser<P extends GenericProject = GenericProject> {
         }
       }
     })
-
-    return this
   }
 
   /**
@@ -154,7 +157,7 @@ export class Releaser<P extends GenericProject = GenericProject> {
    * @returns Project releaser instance for chaining.
    */
   push(branch?: string) {
-    this.queue.push(async () => {
+    return this.enqueue(async () => {
       const { dryRun } = this.options
       const targetBranch = branch || await this.gitClient.getDefaultBranch()
 
@@ -170,17 +173,15 @@ export class Releaser<P extends GenericProject = GenericProject> {
         })
       }
     })
-
-    return this
   }
 
   /**
    * Enqueue a task to publish the project.
    * @param options
    * @returns Project releaser instance for chaining.
    */
-  publish(options?: Omit<Parameters<P['publish']>[0], 'dryRun' | 'logger'>) {
-    this.queue.push(async () => {
+  publish(options?: Omit<GetParameter<P['publish']>, 'dryRun' | 'logger'>) {
+    return this.enqueue(async () => {
       const { isMonorepo } = this
       const { dryRun } = this.options
       const logger = this.logger.createChild('package')
@@ -193,8 +194,6 @@ export class Releaser<P extends GenericProject = GenericProject> {
         ...options
       })
     })
-
-    return this
   }
 
   /**
@@ -203,7 +202,7 @@ export class Releaser<P extends GenericProject = GenericProject> {
    * @returns Project releaser instance for chaining.
    */
   release(releaseCreator: GenericReleaseCreator) {
-    this.queue.push(async () => {
+    return this.enqueue(async () => {
       const { isMonorepo } = this
       const { dryRun } = this.options
       const logger = this.logger.createChild('release')
@@ -216,8 +215,6 @@ export class Releaser<P extends GenericProject = GenericProject> {
         logger
       })
     })
-
-    return this
   }
 
   /**

packages/github-action/.eslintrc.json

@@ -0,0 +1,14 @@
+{
+  "extends": [
+    "@trigen/eslint-config/typescript",
+    "@trigen/eslint-config/typescript-requiring-type-checking",
+    "@trigen/eslint-config/jest"
+  ],
+  "parserOptions": {
+    "tsconfigRootDir": "./packages/github-action",
+    "project": ["./tsconfig.json"]
+  },
+  "rules": {
+    "@typescript-eslint/naming-convention": "off"
+  }
+}

packages/github-action/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@simple-release/github-action",
+  "type": "module",
+  "private": true,
+  "version": "0.0.0",
+  "description": "A simple-release github action.",
+  "author": {
+    "name": "Dan Onoshko",
+    "email": "[email protected]",
+    "url": "https://github.com/dangreen"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/github-action#readme",
+  "funding": "https://ko-fi.com/dangreen",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TrigenSoftware/simple-release.git",
+    "directory": "packages/github-action"
+  },
+  "bugs": {
+    "url": "https://github.com/TrigenSoftware/simple-release/issues"
+  },
+  "keywords": [],
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": "./src/index.ts",
+  "scripts": {
+    "lint": "eslint --parser-options tsconfigRootDir:. '**/*.{js,ts}'",
+    "test:types": "tsc --noEmit",
+    "test": "run -p lint test:types"
+  },
+  "dependencies": {
+    "@actions/core": "^1.11.1",
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^6.0.1",
+    "@simple-release/core": "workspace:^",
+    "@simple-release/pnpm": "workspace:^"
+  }
+}