@jsenv/github-release-package 1.2.1 → 1.3.1

package/package.json

@@ -1,14 +1,20 @@
 {
   "name": "@jsenv/github-release-package",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Create github release when package version changes.",
   "license": "MIT",
+  "author": {
+    "name": "dmail",
+    "email": "dmaillard06@gmail.com",
+    "url": "https://twitter.com/damienmaillard"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jsenv/jsenv-github-release-package"
+    "url": "https://github.com/jsenv/workflow",
+    "directory": "packages/jsenv-github-release-package"
   },
   "engines": {
-    "node": ">=12.8.0"
+    "node": ">=16.13.0"
   },
   "publishConfig": {
     "access": "public",
@@ -17,50 +23,34 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./index.js",
-      "require": "./dist/commonjs/main.cjs"
+      "import": "./main.js"
     }
   },
-  "main": "dist/commonjs/main.cjs",
+  "main": "./main.js",
   "files": [
-    "/dist/",
     "/src/",
-    "/index.js"
+    "/main.js"
   ],
   "scripts": {
-    "test": "node ./script/test/test.js",
-    "test-with-coverage": "node ./script/test/test.js --coverage",
-    "eslint-check": "eslint .",
-    "prettier-format": "node ./script/prettier-format/prettier-format.js",
-    "prettier-format-stage": "npm run prettier-format -- --staged",
-    "prettier-check": "npm run prettier-format -- --dry-run",
-    "upload-coverage": "node ./script/upload-coverage/upload-coverage.js",
-    "generate-commonjs-bundle": "node ./script/generate-commonjs-bundle/generate-commonjs-bundle.js",
-    "generate-import-map": "node ./script/generate-import-map/generate-import-map.js",
-    "install-git-hooks": "node ./script/install-git-hooks/install-git-hooks.js",
-    "dist": "npm run generate-commonjs-bundle",
-    "prepublishOnly": "node ./script/transform-package/remove-postinstall.js && npm run dist",
-    "postpublish": "node ./script/transform-package/restore-postinstall.js",
-    "git-hook-pre-commit": "npm run prettier-format-stage"
+    "eslint": "npx eslint . --ext=.js,.mjs",
+    "importmap": "node ./script/importmap/importmap.mjs",
+    "test": "node ./script/test/test.mjs",
+    "test-with-coverage": "npm run test -- --coverage",
+    "prettier": "prettier --write ."
   },
   "dependencies": {
-    "@jsenv/logger": "3.3.1",
-    "@jsenv/server": "1.6.0",
-    "@jsenv/util": "3.5.2"
+    "@jsenv/filesystem": "2.7.1",
+    "@jsenv/logger": "4.0.1",
+    "@jsenv/github-pull-request-impact": "1.6.6"
   },
   "devDependencies": {
-    "@jsenv/assert": "1.2.2",
-    "@jsenv/codecov-upload": "3.2.0",
-    "@jsenv/core": "11.6.1",
-    "@jsenv/eslint-config": "12.3.1",
-    "@jsenv/git-hooks": "1.3.1",
-    "@jsenv/github-release-package": "1.2.0",
-    "@jsenv/node-module-import-map": "11.0.0",
-    "@jsenv/package-publish": "1.5.0",
-    "@jsenv/prettier-config": "1.2.0",
-    "@jsenv/prettier-check-project": "5.4.0",
-    "babel-eslint": "11.0.0-beta.0",
-    "eslint": "6.8.0",
-    "prettier": "1.19.1"
+    "@jsenv/assert": "2.4.1",
+    "@jsenv/core": "25.3.0",
+    "@jsenv/eslint-config": "16.0.9",
+    "@jsenv/importmap-eslint-resolver": "5.2.5",
+    "@jsenv/importmap-node-module": "5.1.3",
+    "eslint": "8.7.0",
+    "eslint-plugin-import": "2.25.4",
+    "prettier": "2.5.1"
   }
 }

package/readme.md

@@ -1,26 +1,3 @@
-# github-release-package
+# Github Release Package [![npm package](https://img.shields.io/npm/v/@jsenv/github-release-package.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/github-release-package)
 
 Create github release for package version updates.
-
-[![github package](https://img.shields.io/github/package-json/v/jsenv/jsenv-github-release-package.svg?logo=github&label=package)](https://github.com/jsenv/jsenv-github-release-package/packages)
-[![npm package](https://img.shields.io/npm/v/@jsenv/github-release-package.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/github-release-package)
-[![github ci](https://github.com/jsenv/jsenv-github-release-package/workflows/ci/badge.svg)](https://github.com/jsenv/jsenv-github-release-package/actions?workflow=ci)
-[![codecov coverage](https://codecov.io/gh/jsenv/jsenv-github-release-package/branch/master/graph/badge.svg)](https://codecov.io/gh/jsenv/jsenv-github-release-package)
-
-# Table of contents
-
-- [Presentation](#Presentation)
-- [Usage](#Usage)
-- [Installation](#installation)
-
-# Presentation
-
-TODO
-
-# Usage
-
-TODO
-
-# Installation
-
-TODO

package/src/ensureGithubReleaseForPackage.js

@@ -1,112 +1,108 @@
+import * as githubRESTAPI from "@jsenv/github-pull-request-impact/src/internal/github_rest_api.js"
+import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
 import { createLogger } from "@jsenv/logger"
-import {
-  assertAndNormalizeDirectoryUrl,
-  catchCancellation,
-  createCancellationTokenForProcess,
-} from "@jsenv/util"
+
 import { readProjectPackage } from "./internal/readProjectPackage.js"
-import { getGithubRelease } from "./internal/getGithubRelease.js"
-import { createGithubRelease } from "./internal/createGithubRelease.js"
 
 export const ensureGithubReleaseForPackage = async ({
-  cancellationToken = createCancellationTokenForProcess(),
   logLevel,
   projectDirectoryUrl,
-  updateProcessExitCode = true,
 }) => {
-  return catchCancellation(async () => {
-    const logger = createLogger({ logLevel })
-    logger.debug(
-      `autoReleaseOnGithub(${JSON.stringify({ projectDirectoryUrl, logLevel }, null, "  ")})`,
-    )
+  const logger = createLogger({ logLevel })
+  logger.debug(
+    `autoReleaseOnGithub(${JSON.stringify(
+      { projectDirectoryUrl, logLevel },
+      null,
+      "  ",
+    )})`,
+  )
 
-    projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
-
-    const {
-      githubToken,
-      githubRepositoryOwner,
-      githubRepositoryName,
-      githubSha,
-    } = getOptionsFromGithubAction()
+  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
 
-    logger.debug(`reading project package.json`)
-    const { packageVersion } = await getOptionsFromProjectPackage({ projectDirectoryUrl })
-    cancellationToken.throwIfRequested()
-    logger.debug(`${packageVersion} found in package.json`)
+  const {
+    githubToken,
+    githubRepositoryOwner,
+    githubRepositoryName,
+    githubSha,
+  } = getOptionsFromGithubAction()
 
-    logger.debug(`search release for ${packageVersion} on github`)
-    const githubReleaseName = `v${packageVersion}`
-    const existingRelease = await getGithubRelease({
-      githubToken,
-      githubRepositoryOwner,
-      githubRepositoryName,
-      githubReleaseName,
-    })
-    cancellationToken.throwIfRequested()
-    if (existingRelease) {
-      logger.info(
-        `${packageVersion} already released at ${generateReleaseUrl({
-          githubRepositoryOwner,
-          githubRepositoryName,
-          githubReleaseName,
-        })}`,
-      )
-      return
-    }
+  logger.debug(`reading project package.json`)
+  const { packageVersion } = await getOptionsFromProjectPackage({
+    projectDirectoryUrl,
+  })
+  logger.debug(`${packageVersion} found in package.json`)
 
-    logger.info(`creating release for ${packageVersion}`)
-    await createGithubRelease({
-      githubToken,
-      githubRepositoryOwner,
-      githubRepositoryName,
-      githubSha,
-      githubReleaseName,
-    })
+  logger.debug(`search release for ${packageVersion} on github`)
+  const githubReleaseName = `v${packageVersion}`
+  // https://developer.github.com/v3/git/refs/#get-a-single-reference
+  const existingRelease = await githubRESTAPI.GET({
+    url: `https://api.github.com/repos/${githubRepositoryOwner}/${githubRepositoryName}/git/ref/tags/${githubReleaseName}`,
+    githubToken,
+  })
+  if (existingRelease) {
     logger.info(
-      `release created at ${generateReleaseUrl({
+      `${packageVersion} already released at ${generateReleaseUrl({
         githubRepositoryOwner,
         githubRepositoryName,
         githubReleaseName,
       })}`,
     )
-  }).catch((e) => {
-    if (updateProcessExitCode) {
-      process.exitCode = 1
-    }
-    throw e
+    return
+  }
+
+  logger.info(`creating release for ${packageVersion}`)
+  // https://developer.github.com/v3/git/tags/
+  await githubRESTAPI.POST({
+    url: `https://api.github.com/repos/${githubRepositoryOwner}/${githubRepositoryName}/git/refs`,
+    githubToken,
+    body: {
+      ref: `refs/tags/${githubReleaseName}`,
+      sha: githubSha,
+    },
   })
+  logger.info(
+    `release created at ${generateReleaseUrl({
+      githubRepositoryOwner,
+      githubRepositoryName,
+      githubReleaseName,
+    })}`,
+  )
 }
 
-const generateReleaseUrl = ({ githubRepositoryOwner, githubRepositoryName, githubReleaseName }) => {
+const generateReleaseUrl = ({
+  githubRepositoryOwner,
+  githubRepositoryName,
+  githubReleaseName,
+}) => {
   return `https://github.com/${githubRepositoryOwner}/${githubRepositoryName}/releases/tag/${githubReleaseName}`
 }
 
 const getOptionsFromGithubAction = () => {
   const eventName = process.env.GITHUB_EVENT_NAME
   if (!eventName) {
-    throw new Error(`missing process.env.GITHUB_EVENT_NAME, we are not in a github action`)
+    throw new Error(
+      `missing process.env.GITHUB_EVENT_NAME, we are not in a github action`,
+    )
   }
   if (eventName !== "push") {
-    throw new Error(`getOptionsFromGithubAction must be called only in a push action`)
+    throw new Error(
+      `getOptionsFromGithubAction must be called only in a push action`,
+    )
   }
-
   const githubRepository = process.env.GITHUB_REPOSITORY
   if (!githubRepository) {
     throw new Error(`missing process.env.GITHUB_REPOSITORY`)
   }
-
-  const [githubRepositoryOwner, githubRepositoryName] = githubRepository.split("/")
-
+  const [githubRepositoryOwner, githubRepositoryName] =
+    githubRepository.split("/")
   const githubToken = process.env.GITHUB_TOKEN
   if (!githubToken) {
     throw new Error(`missing process.env.GITHUB_TOKEN`)
   }
-
   const githubSha = process.env.GITHUB_SHA
   if (!githubSha) {
     throw new Error(`missing process.env.GITHUB_SHA`)
   }
-
   return {
     githubRepositoryOwner,
     githubRepositoryName,

package/src/internal/readProjectPackage.js

@@ -1,8 +1,7 @@
-import { resolveUrl, urlToFileSystemPath, readFile } from "@jsenv/util"
+import { resolveUrl, urlToFileSystemPath, readFile } from "@jsenv/filesystem"
 
 export const readProjectPackage = async ({ projectDirectoryUrl }) => {
   const packageFileUrl = resolveUrl("./package.json", projectDirectoryUrl)
-
   let packageInProject
   try {
     const packageString = await readFile(packageFileUrl)
@@ -28,6 +27,5 @@ ${urlToFileSystemPath(packageFileUrl)}`,
     }
     throw e
   }
-
   return packageInProject
 }