update channel for feature branches (#92)

* update channel for feature branches * update test
canonical · Mar 16, 2023 · 65ee829 · 65ee829
1 parent 91ef33d
commit 65ee829
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 59 deletions.
diff --git a/channel/README.md b/channel/README.md
@@ -1,6 +1,6 @@
 # canonical/charming-actions/channel
 
-This action allows you to, based on the github reference, decide which channel on CharHhub to release
+This action allows you to, based on the github reference, decide which channel on Charmhub to release
 a change to. In itself, this action does not mutate any state on either GitHub or CharmHub.
 
 ## Usage
@@ -29,9 +29,9 @@ None
 
 ## Branch Selection
 
-This action automatically selects a Charmhub channel based on the Github branch naming. For `push`
-events, a Charmhub channel is selected. For `pull_request` events, a branch is added to the channel, so
-that the PR can be tested.
+This action automatically selects a Charmhub channel based on the GitHub PR number. For `push`
+events, a Charmhub channel is selected. For `pull_request` events, a `pr-<pr number>` is added to the 
+channel, so that the PR can be tested.
 
 The Charmhub channel/branch selection logic looks like this:
 
@@ -40,6 +40,5 @@ The Charmhub channel/branch selection logic looks like this:
 | push         |                 | `<default branch>`   | `latest/edge`                     |
 | push         |                 | `track/<track-name>` | `<track-name>/edge`               |
 | push         |                 | Any other name       | Ignored                           |
-| pull_request | `<branch-name>` | `<default branch>`   | `latest/edge/<branch-name>`       |
-| pull_request | `<branch-name>` | `track/<track-name>` | `<track-name>/edge/<branch-name>` |
-| pull_request | Any other name  | Any other name       | Ignored                           |
+| pull_request | `<branch-name>` | `track/<track-name>` | `<track-name>/edge/pr-<pr number>`|
+| pull_request | Any other name  | Any other name       | `latest/edge/pr-<pr number>`      |
diff --git a/dist/channel/index.js b/dist/channel/index.js
@@ -22854,12 +22854,14 @@ class Charmcraft {
             // however, we expect charmcraft pack to always output one charm file.
             const globber = yield glob.create('./*.charm');
             const paths = yield globber.glob();
+            // filter all characters which are not letters, numbers or hyphens
+            const allowedChannel = channel.replace(/[^a-zA-Z0-9\-/]/gi, '');
             const args = [
                 'upload',
                 '--format',
                 'json',
                 '--release',
-                channel,
+                allowedChannel,
                 paths[0],
                 ...flags,
             ];
@@ -23194,15 +23196,12 @@ class Ref {
         if (!metadata) {
             throw new Error('Pull request metadata missing in the actions context');
         }
-        const { base, head } = metadata;
-        const branch = head.ref.replace('branch/', '');
-        if (base.ref === base.repo.default_branch) {
-            return `latest/edge/${branch}`;
-        }
+        const { base, number } = metadata;
+        const branch = `pr-${number}`;
         if (base.ref.startsWith('track/')) {
             return `${base.ref.replace('track/', '')}/edge/${branch}`;
         }
-        throw new Error(`Unhandled PR base name ${base.ref}`);
+        return `latest/edge/${branch}`;
     }
 }
 exports.Ref = Ref;

diff --git a/dist/check-libraries/index.js b/dist/check-libraries/index.js
@@ -23047,12 +23047,14 @@ class Charmcraft {
             // however, we expect charmcraft pack to always output one charm file.
             const globber = yield glob.create('./*.charm');
             const paths = yield globber.glob();
+            // filter all characters which are not letters, numbers or hyphens
+            const allowedChannel = channel.replace(/[^a-zA-Z0-9\-/]/gi, '');
             const args = [
                 'upload',
                 '--format',
                 'json',
                 '--release',
-                channel,
+                allowedChannel,
                 paths[0],
                 ...flags,
             ];
@@ -23387,15 +23389,12 @@ class Ref {
         if (!metadata) {
             throw new Error('Pull request metadata missing in the actions context');
         }
-        const { base, head } = metadata;
-        const branch = head.ref.replace('branch/', '');
-        if (base.ref === base.repo.default_branch) {
-            return `latest/edge/${branch}`;
-        }
+        const { base, number } = metadata;
+        const branch = `pr-${number}`;
         if (base.ref.startsWith('track/')) {
             return `${base.ref.replace('track/', '')}/edge/${branch}`;
         }
-        throw new Error(`Unhandled PR base name ${base.ref}`);
+        return `latest/edge/${branch}`;
     }
 }
 exports.Ref = Ref;

diff --git a/dist/release-charm/index.js b/dist/release-charm/index.js
@@ -22946,12 +22946,14 @@ class Charmcraft {
             // however, we expect charmcraft pack to always output one charm file.
             const globber = yield glob.create('./*.charm');
             const paths = yield globber.glob();
+            // filter all characters which are not letters, numbers or hyphens
+            const allowedChannel = channel.replace(/[^a-zA-Z0-9\-/]/gi, '');
             const args = [
                 'upload',
                 '--format',
                 'json',
                 '--release',
-                channel,
+                allowedChannel,
                 paths[0],
                 ...flags,
             ];
@@ -23286,15 +23288,12 @@ class Ref {
         if (!metadata) {
             throw new Error('Pull request metadata missing in the actions context');
         }
-        const { base, head } = metadata;
-        const branch = head.ref.replace('branch/', '');
-        if (base.ref === base.repo.default_branch) {
-            return `latest/edge/${branch}`;
-        }
+        const { base, number } = metadata;
+        const branch = `pr-${number}`;
         if (base.ref.startsWith('track/')) {
             return `${base.ref.replace('track/', '')}/edge/${branch}`;
         }
-        throw new Error(`Unhandled PR base name ${base.ref}`);
+        return `latest/edge/${branch}`;
     }
 }
 exports.Ref = Ref;

diff --git a/dist/release-libraries/index.js b/dist/release-libraries/index.js
@@ -23077,12 +23077,14 @@ class Charmcraft {
             // however, we expect charmcraft pack to always output one charm file.
             const globber = yield glob.create('./*.charm');
             const paths = yield globber.glob();
+            // filter all characters which are not letters, numbers or hyphens
+            const allowedChannel = channel.replace(/[^a-zA-Z0-9\-/]/gi, '');
             const args = [
                 'upload',
                 '--format',
                 'json',
                 '--release',
-                channel,
+                allowedChannel,
                 paths[0],
                 ...flags,
             ];
@@ -23417,15 +23419,12 @@ class Ref {
         if (!metadata) {
             throw new Error('Pull request metadata missing in the actions context');
         }
-        const { base, head } = metadata;
-        const branch = head.ref.replace('branch/', '');
-        if (base.ref === base.repo.default_branch) {
-            return `latest/edge/${branch}`;
-        }
+        const { base, number } = metadata;
+        const branch = `pr-${number}`;
         if (base.ref.startsWith('track/')) {
             return `${base.ref.replace('track/', '')}/edge/${branch}`;
         }
-        throw new Error(`Unhandled PR base name ${base.ref}`);
+        return `latest/edge/${branch}`;
     }
 }
 exports.Ref = Ref;

diff --git a/dist/upload-bundle/index.js b/dist/upload-bundle/index.js
@@ -22925,12 +22925,14 @@ class Charmcraft {
             // however, we expect charmcraft pack to always output one charm file.
             const globber = yield glob.create('./*.charm');
             const paths = yield globber.glob();
+            // filter all characters which are not letters, numbers or hyphens
+            const allowedChannel = channel.replace(/[^a-zA-Z0-9\-/]/gi, '');
             const args = [
                 'upload',
                 '--format',
                 'json',
                 '--release',
-                channel,
+                allowedChannel,
                 paths[0],
                 ...flags,
             ];
@@ -23265,15 +23267,12 @@ class Ref {
         if (!metadata) {
             throw new Error('Pull request metadata missing in the actions context');
         }
-        const { base, head } = metadata;
-        const branch = head.ref.replace('branch/', '');
-        if (base.ref === base.repo.default_branch) {
-            return `latest/edge/${branch}`;
-        }
+        const { base, number } = metadata;
+        const branch = `pr-${number}`;
         if (base.ref.startsWith('track/')) {
             return `${base.ref.replace('track/', '')}/edge/${branch}`;
         }
-        throw new Error(`Unhandled PR base name ${base.ref}`);
+        return `latest/edge/${branch}`;
     }
 }
 exports.Ref = Ref;

diff --git a/dist/upload-charm/index.js b/dist/upload-charm/index.js
@@ -22953,12 +22953,14 @@ class Charmcraft {
             // however, we expect charmcraft pack to always output one charm file.
             const globber = yield glob.create('./*.charm');
             const paths = yield globber.glob();
+            // filter all characters which are not letters, numbers or hyphens
+            const allowedChannel = channel.replace(/[^a-zA-Z0-9\-/]/gi, '');
             const args = [
                 'upload',
                 '--format',
                 'json',
                 '--release',
-                channel,
+                allowedChannel,
                 paths[0],
                 ...flags,
             ];
@@ -23293,15 +23295,12 @@ class Ref {
         if (!metadata) {
             throw new Error('Pull request metadata missing in the actions context');
         }
-        const { base, head } = metadata;
-        const branch = head.ref.replace('branch/', '');
-        if (base.ref === base.repo.default_branch) {
-            return `latest/edge/${branch}`;
-        }
+        const { base, number } = metadata;
+        const branch = `pr-${number}`;
         if (base.ref.startsWith('track/')) {
             return `${base.ref.replace('track/', '')}/edge/${branch}`;
         }
-        throw new Error(`Unhandled PR base name ${base.ref}`);
+        return `latest/edge/${branch}`;
     }
 }
 exports.Ref = Ref;

diff --git a/src/services/ref/ref.test.ts b/src/services/ref/ref.test.ts
@@ -5,7 +5,7 @@ function createContext(
   eventName: string,
   ref: string,
   main: string,
-  prRefs: { base?: string; head?: string } = {}
+  prRefs: { base?: string; head?: string; number?: number } = {}
 ) {
   return {
     eventName,
@@ -24,6 +24,7 @@ function createContext(
         head: {
           ref: prRefs.head,
         },
+        number: prRefs.number,
       },
     },
   } as unknown as Context;
@@ -56,17 +57,19 @@ describe('the ref helper', () => {
       const context = createContext('pull_request', '', 'main', {
         base: 'main',
         head: 'branch/PR-123',
+        number: 123,
       });
       const ref = new Ref(context);
-      expect(ref.channel()).toEqual('latest/edge/PR-123');
+      expect(ref.channel()).toEqual('latest/edge/pr-123');
     });
     it('should return some-track/edge/whatever when creating a PR towards main', () => {
       const context = createContext('pull_request', '', 'main', {
         base: 'track/some-track',
         head: 'branch/PR-123',
+        number: 123,
       });
       const ref = new Ref(context);
-      expect(ref.channel()).toEqual('some-track/edge/PR-123');
+      expect(ref.channel()).toEqual('some-track/edge/pr-123');
     });
   });
 });
diff --git a/src/services/ref/ref.ts b/src/services/ref/ref.ts
@@ -48,16 +48,12 @@ export class Ref {
       throw new Error('Pull request metadata missing in the actions context');
     }
 
-    const { base, head } = metadata;
-    const branch = head.ref.replace('branch/', '');
+    const { base, number } = metadata;
+    const branch = `pr-${number}`;
 
-    if (base.ref === base.repo.default_branch) {
-      return `latest/edge/${branch}`;
-    }
     if (base.ref.startsWith('track/')) {
       return `${base.ref.replace('track/', '')}/edge/${branch}`;
     }
-
-    throw new Error(`Unhandled PR base name ${base.ref}`);
+    return `latest/edge/${branch}`;
   }
 }