Use workflow secret to provide API token. Improve feedback to the user.

Author: khlopko

README.md

@@ -66,8 +66,7 @@ To request development snapshots, use one of these options:
 swift-version: "main-snapshot-2024-08-01"
 ```
 
-Or you can omit date to lookup for latest available snapshot (note that you may run into GitHub API limits, 
-which can be avoided if you specify API Token in your project settings)
+Or you can omit date to lookup for latest available snapshot 
 
 ```yaml
 swift-version: "main-snapshot"
@@ -85,6 +84,13 @@ If date is ommited, it will lookup for the latest snapshot
 swift-version: "5.7-snapshot"
 ```
 
+Note that you may run into GitHub API limits, which can be avoided if you pass API token via environment variable
+
+```yaml
+env:
+    GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
 ## Note about versions
 
 This project uses strict semantic versioning to determine what version of Swift to configure. This differs slightly from the official convention used by Swift.

__tests__/snapshot-resolver.test.ts

@@ -3,6 +3,8 @@ import { SnapshotResolver } from "../src/snapshot-resolver";
 import { readFileSync } from "fs";
 
 class MockGitHubClient implements GitHubClient {
+  retryTimeout: number = 0;
+
   hasApiToken(): boolean {
     return true;
   }

dist/index.js

@@ -51,21 +51,21 @@ exports.versionFromString = versionFromString;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.DefaultGitHubClient = void 0;
 class DefaultGitHubClient {
+    retryTimeout = 5000;
     githubToken;
     constructor(githubToken = null) {
-        this.githubToken =
-            githubToken || process.env.API_GITHUB_ACCESS_TOKEN || null;
+        this.githubToken = githubToken || process.env.GH_TOKEN || null;
     }
     hasApiToken() {
         return this.githubToken != null && this.githubToken != "";
     }
     async getTags(page, limit) {
-        const url = `https://api.github.com/repos/apple/swift/tags?per_page=${limit}&page=${page}`;
+        const url = `https://api.github.com/repos/swiftlang/swift/tags?per_page=${limit}&page=${page}`;
         return await this.get(url);
     }
     async get(url) {
         let headers = {};
-        if (this.githubToken) {
+        if (this.hasApiToken()) {
             headers = {
                 Authorization: `Bearer ${this.githubToken}`,
             };
@@ -471,6 +471,7 @@ exports.getSystem = getSystem;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.SnapshotResolver = void 0;
+const core_1 = __nccwpck_require__(2186);
 const github_client_1 = __nccwpck_require__(4072);
 class SnapshotResolver {
     githubClient;
@@ -529,19 +530,8 @@ class SnapshotResolver {
     }
     async getTags(page) {
         let json = await this.githubClient.getTags(page, this.limit);
-        if (!Array.isArray(json)) {
-            // try second time after 5s if response not an array of tags
-            await new Promise((r) => setTimeout(r, 5000));
-            json = await this.githubClient.getTags(page, this.limit);
-        }
-        if (!Array.isArray(json)) {
-            // fail if couldn't get from second try
-            let errorMessage = "Failed to retrive snapshot tags. Please, try again later.";
-            if (!this.githubClient.hasApiToken()) {
-                errorMessage +=
-                    " To avoid limits specify `API_GITHUB_ACCESS_TOKEN` in your project settings.";
-            }
-            throw new Error(errorMessage);
+        if (!this.githubClient.hasApiToken()) {
+            (0, core_1.warning)("To avoid hitting limits specify env variable `GH_TOKEN` in your workflow.");
         }
         const tags = json.map((e) => {
             return { name: e.name };

src/github-client.ts

@@ -1,28 +1,29 @@
 export interface GitHubClient {
+  retryTimeout: number;
   hasApiToken(): boolean;
   getTags(page: number, limit: number): Promise<any>;
 }
 
 export class DefaultGitHubClient implements GitHubClient {
+  retryTimeout: number = 5000;
   private githubToken: string | null;
 
   constructor(githubToken: string | null = null) {
-    this.githubToken =
-      githubToken || process.env.API_GITHUB_ACCESS_TOKEN || null;
+    this.githubToken = githubToken || process.env.GH_TOKEN || null;
   }
 
   hasApiToken(): boolean {
     return this.githubToken != null && this.githubToken != "";
   }
 
   async getTags(page: number, limit: number): Promise<any> {
-    const url = `https://api.github.com/repos/apple/swift/tags?per_page=${limit}&page=${page}`;
+    const url = `https://api.github.com/repos/swiftlang/swift/tags?per_page=${limit}&page=${page}`;
     return await this.get(url);
   }
 
   private async get(url: string): Promise<any> {
     let headers = {};
-    if (this.githubToken) {
+    if (this.hasApiToken()) {
       headers = {
         Authorization: `Bearer ${this.githubToken}`,
       };

src/snapshot-resolver.ts

@@ -1,3 +1,4 @@
+import { warning } from "@actions/core";
 import { DefaultGitHubClient, GitHubClient } from "./github-client";
 import { System } from "./os";
 
@@ -77,20 +78,10 @@ export class SnapshotResolver {
 
   private async getTags(page: number): Promise<Tag[]> {
     let json = await this.githubClient.getTags(page, this.limit);
-    if (!Array.isArray(json)) {
-      // try second time after 5s if response not an array of tags
-      await new Promise((r) => setTimeout(r, 5000));
-      json = await this.githubClient.getTags(page, this.limit);
-    }
-    if (!Array.isArray(json)) {
-      // fail if couldn't get from second try
-      let errorMessage =
-        "Failed to retrive snapshot tags. Please, try again later.";
-      if (!this.githubClient.hasApiToken()) {
-        errorMessage +=
-          " To avoid limits specify `API_GITHUB_ACCESS_TOKEN` in your project settings.";
-      }
-      throw new Error(errorMessage);
+    if (!this.githubClient.hasApiToken()) {
+      warning(
+        "To avoid hitting limits specify env variable `GH_TOKEN` in your workflow."
+      );
     }
     const tags: Tag[] = json.map((e: any) => {
       return { name: e.name };