You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,8 @@ $ ./out/auth0 --help
34
34
35
35
This part is not fully fleshed out yet, but here are the steps:
36
36
37
-
1. Create a command (example: https://github.com/auth0/auth0-cli/blob/main/internal/cli/login.go)
38
-
2. Add the command constructor to the root command: (e.g. somewhere here: https://github.com/auth0/auth0-cli/blob/main/internal/cli/root.go)
37
+
1. Create a command (example: https://github.com/auth0/auth0-cli/blob/beta/internal/cli/login.go)
38
+
2. Add the command constructor to the root command: (e.g. somewhere here: https://github.com/auth0/auth0-cli/blob/beta/internal/cli/root.go)
39
39
40
40
Test it out by doing:
41
41
@@ -60,22 +60,23 @@ We use vendoring, so the last step is required.
60
60
> This is only possible if you're a repository maintainer.
61
61
62
62
The release is driven by a GitHub **workflow** triggered when a new **tag** is **created**. The workflow will run the checks and trigger _Goreleaser_ to:
63
-
- create the Release with the proper description (changelog)
63
+
- create the pre-release with the proper description (changelog)
64
64
- upload the binaries for the different architectures
65
-
- update https://github.com/auth0/homebrew-auth0-cli with the latest binary reference
66
65
67
-
To release a new version:
66
+
> **Note:** Homebrew and Scoop are not updated for beta releases.
67
+
68
+
To release a new beta version:
68
69
69
70
1. pull the latest changes:
70
-
-`$ git checkout main`
71
-
-`$ git pull origin main`
71
+
-`$ git checkout beta`
72
+
-`$ git pull origin beta`
72
73
2. check the latest tag:
73
74
-`$ git fetch`
74
-
-`$ git tags`
75
-
3. create the **new** tag for the new release. For example, if the latest tag is `v0.1.1` and you want to release a patch version, you should create `v0.1.2`:
76
-
-`$ git tag v0.1.2`
75
+
-`$ git tag --list`
76
+
3. create the **new**beta tag. Beta releases use the format `vX.Y.Z-beta.N`. For example, if the latest tag is `v1.32.0-beta.1` and you want the next beta, create `v1.32.0-beta.2`:
77
+
-`$ git tag v1.32.0-beta.2`
77
78
4. push the new tag:
78
-
-`$ git push origin v0.1.2`
79
+
-`$ git push origin v1.32.0-beta.2`
79
80
80
81
The rest of the process will take place in the github action: https://github.com/auth0/auth0-cli/actions/workflows/goreleaser.yml.
81
82
Once the workflow finishes, a new release will be available for the newly created tag.
> This is a **beta release** of the Auth0 CLI and is not yet generally available. Features and behavior may change before the final release. Installation via Homebrew and Scoop is not supported for beta — use cURL, PowerShell, Go, or Manual installation instead.
18
+
16
19
Build, manage and test your [Auth0](https://auth0.com/) integrations from the command line.
17
20
18
21

@@ -36,17 +39,11 @@ Build, manage and test your [Auth0](https://auth0.com/) integrations from the co
36
39
37
40
### Linux and macOS
38
41
39
-
Install via [Homebrew](https://brew.sh/):
40
-
41
-
```bash
42
-
brew tap auth0/auth0-cli && brew install auth0
43
-
```
44
-
45
42
Install via [cURL](https://curl.se/):
46
43
47
44
1. Download the binary. It will be placed in `./auth0`:
48
45
```bash
49
-
curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b .
46
+
curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/beta/install.sh | sh -s -- -b .
50
47
```
51
48
2. Optionally, if you want to be able to run the binary from any directory, make sure you move it to a place in your $PATH:
52
49
```bash
@@ -57,19 +54,11 @@ Install via [cURL](https://curl.se/):
@@ -91,12 +80,14 @@ Install via [Go](https://go.dev/):
91
80
```bash
92
81
# Make sure your $GOPATH/bin is exported on your $PATH
93
82
# to be able to run the binary from any directory.
94
-
go install github.com/auth0/auth0-cli/cmd/auth0@latest
83
+
# Replace <beta-tag> with the latest beta release tag (e.g. v1.33.0-beta.1).
84
+
# See https://github.com/auth0/auth0-cli/releases for available tags.
85
+
go install github.com/auth0/auth0-cli/cmd/auth0@<beta-tag>
95
86
```
96
87
97
88
### Manual
98
89
99
-
1. Download the appropriate binary for your environment from the [latest release](https://github.com/auth0/auth0-cli/releases/latest/)
90
+
1. Download the appropriate binary for your environment from the [releases page](https://github.com/auth0/auth0-cli/releases) — select the most recent pre-release
100
91
2. Extract the archive
101
92
-**macOS**: `$ tar -xf auth0-cli_{version}_Darwin_{architecture}.tar.gz`
102
93
-**Linux**: `$ tar -xf auth0-cli_{version}_Linux_{architecture}.tar.gz`
@@ -282,7 +273,7 @@ We appreciate feedback and contribution to this repo! Before you get started, pl
282
273
283
274
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
284
275
- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
@@ -303,4 +294,4 @@ Please do not report security vulnerabilities on the public GitHub issue tracker
303
294
</p>
304
295
<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
305
296
<p align="center">
306
-
This project is licensed under the MIT license. See the <a href="https://github.com/auth0/auth0-cli/blob/main/LICENSE"> LICENSE</a> file for more info.</p>
297
+
This project is licensed under the MIT license. See the <a href="https://github.com/auth0/auth0-cli/blob/beta/LICENSE"> LICENSE</a> file for more info.</p>
0 commit comments