semantic-release-pub 0.2.1 → 0.3.0

package/README.md

@@ -12,7 +12,7 @@
 | 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.                                                                                                                                                   |
+| `prepare`          | Update the `pubspec.yaml` 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
@@ -42,3 +42,69 @@ The plugin can be configured in the [semantic-release configuration file](https:
   ]
 }
 ```
+
+## Configuration
+
+### `pub.dev` authentication
+
+The following instructions are referenced from the [documentation](https://dart.dev/tools/pub/automated-publishing#publish-using-exported-service-account-keys) of Dart. Below are the key steps to allow authentication to `pub.dev`.
+
+1. [Create a Google Cloud project](https://cloud.google.com/resource-manager/docs/creating-managing-projects), if you don’t have an existing project.
+
+2. Create a [service account](https://cloud.google.com/iam/docs/service-account-overview) either through the Google Cloud Console under `IAM and admin > Service accounts` or as follow:
+   
+    ```bash
+    gcloud iam service-accounts create pub-dev \
+        --description='Service account to be impersonated when publishing to pub.dev' \
+        --display-name='pub-dev'
+    ```
+
+3. Grant the service account permission to publish your package.
+
+    > To complete this step, you must have uploader permission on the package or be an admin of the publisher that owns the package.
+
+    1. Navigate to the Admin tab (pub.dev/packages/<package>/admin).
+    2. Click Enable publishing with Google Cloud Service account. 
+    3. Type the email of the service account into the Service account email field.
+        > You created this account in the previous step: `pub-dev@$PROJECT_ID.iam.gserviceaccount.com`
+
+4. Create exported service account keys for the service account either through the Google Cloud Console under `Service account actions > Manage keys > Add key > Create new key > JSON > Create` or as follow:
+
+    ```bash
+    gcloud iam service-accounts keys create key-file.json \
+        PROJECT_ID.iam.gserviceaccount.com
+    ```
+
+5. Copy the content of the JSON key file and set it as an environment variable under `GOOGLE_SERVICE_ACCOUNT_KEY`.
+
+### Environment variables
+
+| Variable                     | Description                                                  |
+| ---------------------------- | ------------------------------------------------------------ |
+| `GOOGLE_SERVICE_ACCOUNT_KEY` | The google service account key created from the above steps. |
+
+### Options
+
+| Option       | Description                                                                                                          | Default |
+| ------------ | -------------------------------------------------------------------------------------------------------------------- | ------- |
+| `cli`        | The `dart` or `flutter` CLI to use to publish the package to the registry.                                           | `dart`  |
+| `publishPub` | Whether to publish the package to the registry. If set to `false`, the `pubspec.yaml` version will still be updated. | `true`  |
+
+### Examples
+
+#### Publishing a Flutter package
+
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer", 
+    "@semantic-release/release-notes-generator", 
+    [
+      "semantic-release-pub",
+      {
+        "cli": "flutter"
+      }
+    ]
+  ]
+}
+```

package/dist/prepare.d.ts

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

package/dist/prepare.js

@@ -1,11 +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_PATH = 'pubspec.yaml';
+export const prepare = async ({ nextRelease: { version }, logger }) => {
+    const data = readFileSync(PUBSPEC_PATH, 'utf-8');
     const pubspec = Pubspec.parse(parse(data));
-    const newData = data.replace(new RegExp(`^version:.*${pubspec.version}`), `version: ${nextRelease.version}`);
-    writeFileSync(pubspecPath, newData);
+    const newData = data.replace(new RegExp(`version:[ \t]+${pubspec.version}`), `version: ${version}`);
+    logger.log(`Writing version ${version} to ${PUBSPEC_PATH}`);
+    writeFileSync(PUBSPEC_PATH, newData);
 };

package/dist/publish.d.ts

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

package/dist/publish.js

@@ -1,12 +1,18 @@
 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);
+export const publish = async (pluginConfig, { nextRelease: { version }, logger }) => {
+    const { cli, publishPub } = getConfig(pluginConfig);
+    if (!publishPub) {
+        logger.log(`Skipping publishing to pub.dev as publishPub is ${publishPub}`);
+        return;
+    }
     const { GOOGLE_SERVICE_ACCOUNT_KEY } = process.env;
     const idToken = await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
     await setPubToken(cli, idToken);
-    await publishToPub(cli);
+    logger.log(`Publishing version ${version} to pub.dev`);
+    await execa(cli, ['pub', 'publish', '--force']);
+    logger.log('Published package');
 };
 const setPubToken = async (cli, idToken) => {
     process.env[SEMANTIC_RELEASE_PUB_TOKEN] = idToken;
@@ -18,6 +24,3 @@ const setPubToken = async (cli, idToken) => {
         `--env-var=${SEMANTIC_RELEASE_PUB_TOKEN}`
     ]);
 };
-const publishToPub = async (cli) => {
-    await execa(cli, ['pub', 'publish', '--force']);
-};

package/dist/types.d.ts

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

package/dist/utils.js

@@ -3,7 +3,7 @@ import { JWT } from 'google-auth-library';
 import { ServiceAccount } from './schemas.js';
 const DEFAULT_CONFIG = {
     cli: 'dart',
-    pubspecPath: 'pubspec.yaml'
+    publishPub: true
 };
 const PUB_DEV_AUDIENCE = 'https://pub.dev';
 export const getConfig = (config) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semantic-release-pub",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "semantic-release plugin to publish a Dart or Flutter package",
   "main": "dist/index.js",
   "author": "zeshuaro@gmail.com",
@@ -44,6 +44,7 @@
     "@types/common-tags": "^1.8.2",
     "@types/semantic-release": "^20.0.1",
     "@types/semantic-release__error": "^3.0.0",
+    "@types/signale": "^1.4.4",
     "@typescript-eslint/eslint-plugin": "^6.7.2",
     "@typescript-eslint/parser": "^6.7.2",
     "@vitest/coverage-v8": "^0.34.4",