feat!: use "~> v2" as default (#463)

* feat!: use "~> v2" as default Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * fix: more changes Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * gen Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * docs: update * docs: update --------- Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
goreleaser · Jun 5, 2024 · 18bbabc · 18bbabc
1 parent 5742e2a
commit 18bbabc
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -59,15 +59,15 @@ jobs:
           fetch-depth: 0
       -
         name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
           # either 'goreleaser' (default) or 'goreleaser-pro'
           distribution: goreleaser
           # 'latest', 'nightly', or a semver
-          version: '~> v1'
+          version: '~> v2'
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -93,10 +93,10 @@ Or with a condition on GoReleaser step:
 ```yaml
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         if: startsWith(github.ref, 'refs/tags/')
         with:
-          version: '~> v1'
+          version: '~> v2'
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -119,9 +119,9 @@ the [Import GPG](https://github.com/crazy-max/ghaction-import-gpg) GitHub Action
           passphrase: ${{ secrets.PASSPHRASE }}
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
-          version: '~> v1'
+          version: '~> v2'
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -144,9 +144,9 @@ purpose. You can do that with the [actions/upload-artifact](https://github.com/a
 ```yaml
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
-          version: '~> v1'
+          version: '~> v2'
           args: release --clean
           workdir: myfolder
         env:
@@ -165,7 +165,7 @@ purpose. You can do that with the [actions/upload-artifact](https://github.com/a
 steps:
   -
     name: Install GoReleaser
-    uses: goreleaser/goreleaser-action@v5
+    uses: goreleaser/goreleaser-action@v6
     with:
       install-only: true
   -
@@ -182,7 +182,7 @@ Following inputs can be used as `step.with` keys
 | Name             | Type    | Default      | Description                                                      |
 |------------------|---------|--------------|------------------------------------------------------------------|
 | `distribution`   | String  | `goreleaser` | GoReleaser distribution, either `goreleaser` or `goreleaser-pro` |
-| `version`**¹**   | String  | `~> v1`      | GoReleaser version                                               |
+| `version`**¹**   | String  | `~> v2`      | GoReleaser version                                               |
 | `args`           | String  |              | Arguments to pass to GoReleaser                                  |
 | `workdir`        | String  | `.`          | Working directory (below repository root)                        |
 | `install-only`   | Bool    | `false`      | Just install GoReleaser                                          |
@@ -219,9 +219,9 @@ secret named `GH_PAT`, the step will look like this:
 ```yaml
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
-          version: '~> v1'
+          version: '~> v2'
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GH_PAT }}

diff --git a/__tests__/github.test.ts b/__tests__/github.test.ts
@@ -44,6 +44,18 @@ describe('getRelease', () => {
     expect(release?.tag_name).not.toEqual('');
   });
 
+  it('returns latest v2 GoReleaser Pro GitHub release', async () => {
+    const release = await github.getRelease('goreleaser-pro', '~> v2');
+    expect(release).not.toBeNull();
+    expect(release?.tag_name).not.toEqual('');
+  });
+
+  it('returns latest v2 GoReleaser GitHub release', async () => {
+    const release = await github.getRelease('goreleaser', '~> v2');
+    expect(release).not.toBeNull();
+    expect(release?.tag_name).not.toEqual('');
+  });
+
   it('returns nightly GoReleaser GitHub release', async () => {
     const release = await github.getRelease('goreleaser', 'nightly');
     expect(release).not.toBeNull();

diff --git a/__tests__/goreleaser.test.ts b/__tests__/goreleaser.test.ts
@@ -28,6 +28,16 @@ describe('install', () => {
     expect(fs.existsSync(bin)).toBe(true);
   }, 100000);
 
+  it('acquires latest v2 version of GoReleaser', async () => {
+    const bin = await goreleaser.install('goreleaser', '~> v2');
+    expect(fs.existsSync(bin)).toBe(true);
+  }, 100000);
+
+  it('acquires latest v2 version of GoReleaser Pro', async () => {
+    const bin = await goreleaser.install('goreleaser-pro', '~> v2');
+    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/action.yml b/action.yml
@@ -13,7 +13,7 @@ inputs:
     required: false
   version:
     description: 'GoReleaser version'
-    default: '~> v1'
+    default: '~> v2'
     required: false
   args:
     description: 'Arguments to pass to GoReleaser'

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/context.ts b/src/context.ts
@@ -15,7 +15,7 @@ export interface Inputs {
 export async function getInputs(): Promise<Inputs> {
   return {
     distribution: core.getInput('distribution') || 'goreleaser',
-    version: core.getInput('version') || '~> v1',
+    version: core.getInput('version') || '~> v2',
     args: core.getInput('args'),
     workdir: core.getInput('workdir') || '.',
     installOnly: core.getBooleanInput('install-only')

diff --git a/src/github.ts b/src/github.ts
@@ -8,10 +8,9 @@ export interface GitHubRelease {
 }
 
 export const getRelease = async (distribution: string, version: string): Promise<GitHubRelease> => {
-  // TODO: change this to ~> v2 on a future major, once goreleaser v2 is out
   if (version === 'latest') {
-    core.warning("You are using 'latest' as default version. Will lock to '~> v1'.");
-    return getReleaseTag(distribution, '~> v1');
+    core.warning("You are using 'latest' as default version. Will lock to '~> v2'.");
+    return getReleaseTag(distribution, '~> v2');
   }
   return getReleaseTag(distribution, version);
 };