semantic-release-pub 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 zeshuaro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# semantic-release-pub
+
+[semantic-release](https://github.com/semantic-release/semantic-release) plugin to publish a [Dart](https://dart.dev/guides/libraries/create-packages) or [Flutter](https://docs.flutter.dev/packages-and-plugins/developing-packages) package.
+
+[![npm](https://img.shields.io/npm/v/semantic-release-pub)](https://www.npmjs.com/package/semantic-release-pub)
+[![License](https://img.shields.io/github/license/zeshuaro/semantic-release-pub)](https://github.com/zeshuaro/semantic-release-pub/blob/main/LICENSE)
+[![GitHub Actions](https://github.com/zeshuaro/semantic-release-pub/actions/workflows/github-actions.yml/badge.svg)](https://github.com/zeshuaro/semantic-release-pub/actions/workflows/github-actions.yml)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=semantic-release-pub&metric=coverage)](https://sonarcloud.io/summary/new_code?id=semantic-release-pub)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=semantic-release-pub&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=semantic-release-pub)
+[![Code Style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+| Step               | Description                                                                                                                                                                         |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `verifyConditions` | Verify the presence of the `GOOGLE_SERVICE_ACCOUNT_KEY` environment variable, the ability to exchange an identity from the service account, and the `dart` or `flutter` executable. |
+| `prepare`          | Update the `pubspec.yml` version.                                                                                                                                                   |
+| `publish`          | Publish the [Dart](https://dart.dev/tools/pub/publishing) or [Flutter](https://docs.flutter.dev/packages-and-plugins/developing-packages#publish) package to the registry.          |
+
+## Installation
+
+Install via `npm`:
+
+```bash
+npm install --save-dev semantic-release-pub
+```
+
+Or via `yarn`:
+
+```bash
+yarn add --dev semantic-release-pub
+```
+
+## Usage
+
+The plugin can be configured in the [semantic-release configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
+
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer", 
+    "@semantic-release/release-notes-generator", 
+    "semantic-release-pub"
+  ]
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { verifyConditions } from './verifyConditions.js';
+export { PluginConfig } from './types.js';
+export { prepare } from './prepare.js';
+export { publish } from './publish.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export { verifyConditions } from './verifyConditions.js';
+export { prepare } from './prepare.js';
+export { publish } from './publish.js';

package/dist/prepare.d.ts

@@ -0,0 +1,3 @@
+import { PrepareContext } from 'semantic-release';
+import { PluginConfig } from './types.js';
+export declare const prepare: (pluginConfig: PluginConfig, { nextRelease }: PrepareContext) => Promise<void>;

package/dist/prepare.js

@@ -0,0 +1,11 @@
+import { readFileSync, writeFileSync } from 'fs';
+import { parse } from 'yaml';
+import { Pubspec } from './schemas.js';
+import { getConfig } from './utils.js';
+export const prepare = async (pluginConfig, { nextRelease }) => {
+    const { pubspecPath } = getConfig(pluginConfig);
+    const data = readFileSync(pubspecPath, 'utf-8');
+    const pubspec = Pubspec.parse(parse(data));
+    const newData = data.replace(new RegExp(`^version:.*${pubspec.version}`), `version: ${nextRelease.version}`);
+    writeFileSync(pubspecPath, newData);
+};

package/dist/publish.d.ts

@@ -0,0 +1,2 @@
+import { PluginConfig } from './types.js';
+export declare const publish: (pluginConfig: PluginConfig) => Promise<void>;

package/dist/publish.js

@@ -0,0 +1,23 @@
+import { execa } from 'execa';
+import { getConfig, getGoogleIdentityToken } from './utils.js';
+const SEMANTIC_RELEASE_PUB_TOKEN = 'SEMANTIC_RELEASE_PUB_TOKEN';
+export const publish = async (pluginConfig) => {
+    const { cli } = getConfig(pluginConfig);
+    const { GOOGLE_SERVICE_ACCOUNT_KEY } = process.env;
+    const idToken = await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
+    await setPubToken(cli, idToken);
+    await publishToPub(cli);
+};
+const setPubToken = async (cli, idToken) => {
+    process.env[SEMANTIC_RELEASE_PUB_TOKEN] = idToken;
+    await execa(cli, [
+        'pub',
+        'token',
+        'add',
+        'https://pub.dev',
+        `--env-var=${SEMANTIC_RELEASE_PUB_TOKEN}`
+    ]);
+};
+const publishToPub = async (cli) => {
+    await execa(cli, ['pub', 'publish', '--force']);
+};

package/dist/schemas.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export declare const ServiceAccount: z.ZodObject<{
+    client_email: z.ZodString;
+    private_key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    client_email?: string;
+    private_key?: string;
+}, {
+    client_email?: string;
+    private_key?: string;
+}>;
+export type ServiceAccount = z.infer<typeof ServiceAccount>;
+export declare const Pubspec: z.ZodObject<{
+    version: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    version?: string;
+}, {
+    version?: string;
+}>;
+export type Pubspec = z.infer<typeof Pubspec>;

package/dist/schemas.js

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export const ServiceAccount = z.object({
+    client_email: z.string(),
+    private_key: z.string()
+});
+export const Pubspec = z.object({ version: z.string() });

package/dist/types.d.ts

@@ -0,0 +1,4 @@
+export type PluginConfig = {
+    cli: 'dart' | 'flutter';
+    pubspecPath: string;
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { PluginConfig } from './types.js';
+export declare const getConfig: (config: PluginConfig) => PluginConfig;
+export declare const getGoogleIdentityToken: (serviceAccountStr: string) => Promise<string>;

package/dist/utils.js

@@ -0,0 +1,28 @@
+import SemanticReleaseError from '@semantic-release/error';
+import { JWT } from 'google-auth-library';
+import { ServiceAccount } from './schemas.js';
+const DEFAULT_CONFIG = {
+    cli: 'dart',
+    pubspecPath: 'pubspec.yml'
+};
+const PUB_DEV_AUDIENCE = 'https://pub.dev';
+export const getConfig = (config) => {
+    return { ...DEFAULT_CONFIG, ...config };
+};
+export const getGoogleIdentityToken = async (serviceAccountStr) => {
+    const serviceAccountJson = getServiceAccount(serviceAccountStr);
+    const jwtClient = new JWT(serviceAccountJson.client_email, undefined, serviceAccountJson.private_key, PUB_DEV_AUDIENCE);
+    const creds = await jwtClient.authorize();
+    if (!creds.id_token) {
+        throw new SemanticReleaseError('Failed to retrieve identity token from Google');
+    }
+    return creds.id_token;
+};
+const getServiceAccount = (serviceAccountStr) => {
+    try {
+        return ServiceAccount.parse(JSON.parse(serviceAccountStr));
+    }
+    catch (error) {
+        throw new SemanticReleaseError(`Invalid service account: ${error}`);
+    }
+};

package/dist/verifyConditions.d.ts

@@ -0,0 +1,2 @@
+import { PluginConfig } from './types.js';
+export declare const verifyConditions: (pluginConfig: PluginConfig) => Promise<void>;

package/dist/verifyConditions.js

@@ -0,0 +1,20 @@
+import SemanticReleaseError from '@semantic-release/error';
+import { execa } from 'execa';
+import { getConfig, getGoogleIdentityToken } from './utils.js';
+export const verifyConditions = async (pluginConfig) => {
+    const { cli } = getConfig(pluginConfig);
+    const { GOOGLE_SERVICE_ACCOUNT_KEY } = process.env;
+    if (!GOOGLE_SERVICE_ACCOUNT_KEY) {
+        throw new SemanticReleaseError('Environment variable not found: GOOGLE_SERVICE_ACCOUNT_KEY');
+    }
+    await verifyCommand(cli);
+    await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
+};
+const verifyCommand = async (command) => {
+    try {
+        await execa(command);
+    }
+    catch (error) {
+        throw new SemanticReleaseError(`${command} returned an error: ${error}`);
+    }
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "semantic-release-pub",
+  "version": "0.2.0",
+  "description": "semantic-release plugin to publish a Dart or Flutter package",
+  "main": "dist/index.js",
+  "author": "zeshuaro@gmail.com",
+  "license": "MIT",
+  "type": "module",
+  "homepage": "https://github.com/zeshuaro/semantic-release-pub",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zeshuaro/semantic-release-pub"
+  },
+  "keywords": [
+    "dart",
+    "flutter",
+    "publish",
+    "registry",
+    "semantic-release",
+    "version"
+  ],
+  "files": [
+    "dist/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run tests --coverage",
+    "lint": "eslint --ext .ts src tests && prettier --check src/**/*.ts tests/**/*.ts",
+    "format": "eslint --ext .ts --fix src tests && prettier --write src/**/*.ts tests/**/*.ts"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@semantic-release/error": "^4.0.0",
+    "execa": "^8.0.1",
+    "google-auth-library": "^9.0.0",
+    "yaml": "^2.3.2",
+    "zod": "^3.22.2"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/common-tags": "^1.8.2",
+    "@types/semantic-release": "^20.0.1",
+    "@types/semantic-release__error": "^3.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
+    "@vitest/coverage-v8": "^0.34.4",
+    "common-tags": "^1.8.2",
+    "conventional-changelog-conventionalcommits": "^7.0.2",
+    "eslint": "^8.13.0",
+    "eslint-config-semistandard": "^17.0.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "prettier": "^3.0.3",
+    "semantic-release": "^21.1.2",
+    "typescript": "^5.1.6",
+    "vitest": "^0.34.4",
+    "vitest-mock-extended": "^1.2.1"
+  }
+}