feat: warn about using 'latest'

goreleaser · Apr 27, 2024 · b885aa7 · b885aa7
1 parent 62d4b8a
commit b885aa7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/__tests__/goreleaser.test.ts b/__tests__/goreleaser.test.ts
@@ -18,6 +18,16 @@ describe('install', () => {
     expect(fs.existsSync(bin)).toBe(true);
   }, 100000);
 
+  it('acquires latest v1 version of GoReleaser', async () => {
+    const bin = await goreleaser.install('goreleaser', '~> v1');
+    expect(fs.existsSync(bin)).toBe(true);
+  }, 100000);
+
+  it('acquires latest v1 version of GoReleaser Pro', async () => {
+    const bin = await goreleaser.install('goreleaser-pro', '~> v1');
+    expect(fs.existsSync(bin)).toBe(true);
+  }, 100000);
+
   it('acquires latest version of GoReleaser Pro', async () => {
     const bin = await goreleaser.install('goreleaser-pro', 'latest');
     expect(fs.existsSync(bin)).toBe(true);

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/github.ts b/src/github.ts
@@ -9,6 +9,9 @@ export interface GitHubRelease {
 
 export const getRelease = async (distribution: string, version: string): Promise<GitHubRelease> => {
   if (version === 'latest') {
+    core.warning(
+      "You are using 'latest' as default version. This might include breaking changes. It is recommended to use a SemVer to lock to a major version (e.g. ~> v1)."
+    );
     return getLatestRelease(distribution);
   }
   return getReleaseTag(distribution, version);