Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support netrc-based credentials in buf-setup-action #94

Merged
merged 23 commits into from
Jan 12, 2023
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
7a14b15
change something
tonyli233 Jan 9, 2023
be4f737
try to execute login command in run.ts
tonyli233 Jan 9, 2023
c725200
check if username and token are provided
tonyli233 Jan 10, 2023
215ab54
check if username and token are provided
tonyli233 Jan 10, 2023
ee0623f
check if username and token are provided
tonyli233 Jan 10, 2023
85b4db9
check if username and token are provided
tonyli233 Jan 10, 2023
ad4533f
check if username and token are provided
tonyli233 Jan 10, 2023
3374f1a
check if username and token are provided
tonyli233 Jan 10, 2023
ec79631
add build files
tonyli233 Jan 10, 2023
d71fe44
add build files
tonyli233 Jan 10, 2023
9f0ea57
modified error message for not supplying buf_user and buf_token
tonyli233 Jan 10, 2023
c8f6690
modified error message for not supplying buf_user and buf_token
tonyli233 Jan 10, 2023
df9d83f
updated readme on the new inputs. updated the input name of buf_api_t…
tonyli233 Jan 10, 2023
a8bd94e
add build files for the last change
tonyli233 Jan 10, 2023
ca91843
updated changes on "Buf Schema Registry" to prevent confusion
tonyli233 Jan 10, 2023
42117b5
Update README.md
tonyli233 Jan 10, 2023
2c1f9d1
separated parameters and other configurations in readme
tonyli233 Jan 10, 2023
9d52aef
updated run.ts to avoid nested if statements to improve readability
tonyli233 Jan 10, 2023
4628eac
added missing return statement
tonyli233 Jan 10, 2023
a4e8927
update readme to avoid confusion between two methods of authentication
tonyli233 Jan 11, 2023
76f3969
Update README.md
tonyli233 Jan 12, 2023
144c24f
update readme
tonyli233 Jan 12, 2023
57d6f51
update readme
tonyli233 Jan 12, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
separated parameters and other configurations in readme
  • Loading branch information
tonyli233 committed Jan 10, 2023
commit 2c1f9d1fec597c70eb76dbccad7171e7d3a75c21
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ steps:

## Configuration

### Parameters

You can configure `buf-setup-action` with these parameters:

| Parameter | Description | Default |
Expand All @@ -36,7 +38,7 @@ You can configure `buf-setup-action` with these parameters:
| `buf_api_token` | The API token to use for logging into Buf Schema registry. | |

> These parameters are derived from [`action.yml`](./action.yml). <br>
### Version
#### Version

If `version` is unspecified, the latest version of `buf` is installed:

Expand Down Expand Up @@ -73,7 +75,7 @@ steps:
- run: buf --version
```

### GitHub token
#### GitHub token

Optionally, you can supply a `github_token` input so that any GitHub API requests are authenticated.
This may prevent rate limit issues when running on GitHub hosted runners:
Expand All @@ -85,7 +87,7 @@ steps:
github_token: ${{ github.token }}
```

### Buf username and Buf API token
#### Buf username and Buf API token

Optionally, you can supply both `buf_user` and `buf_api_token` input so that it will perform BSR authentication
at the same time. Then you do not need to authenticate with the [Buf Schema Registry][bsr] (BSR) directly from a workflow step.
Expand All @@ -100,7 +102,9 @@ steps:
# you can authenticate in this way without specifying env.BUF_TOKEN
```

### Buf token
### Other Configurations

#### Buf token

When calling the `buf` command directly from a workflow step, you may need to authenticate with the
[Buf Schema Registry][bsr] (BSR). You can authenticate by setting the [`BUF_TOKEN`][buf-token]
Expand All @@ -112,7 +116,7 @@ env:
BUF_TOKEN: ${{ secrets.BUF_TOKEN }}
```

### Installing `protoc`
#### Installing `protoc`

In most cases, you _don't_ need to install [`protoc`][protoc] for Buf's GitHub Actions, but some
`protoc` plugins are built into the compiler itself. If you need to execute one of these plugins,
Expand Down