mirror of
https://github.com/goreleaser/goreleaser.git
synced 2024-12-27 01:33:39 +02:00
docs: fix some broken URLs
This commit is contained in:
parent
9bdbf7297d
commit
218beccdd4
@ -5,14 +5,14 @@ DevOps][goreleaser-extension] through [Visual Studio marketplace][marketplace].
|
||||
|
||||
### Task definition
|
||||
|
||||
````yaml
|
||||
```yaml
|
||||
- task: goreleaser@0
|
||||
inputs:
|
||||
version: 'latest'
|
||||
distribution: 'goreleaser'
|
||||
args: ''
|
||||
workdir: '$(Build.SourcesDirectory)'
|
||||
````
|
||||
version: "latest"
|
||||
distribution: "goreleaser"
|
||||
args: ""
|
||||
workdir: "$(Build.SourcesDirectory)"
|
||||
```
|
||||
|
||||
### Task inputs
|
||||
|
||||
@ -20,41 +20,40 @@ Following inputs can be used:
|
||||
|
||||
<!-- to format the tables, use: https://tabletomarkdown.com/format-markdown-table/ -->
|
||||
|
||||
Name |Type |Default |Description
|
||||
-------------------|------|---------------------------|----------------------------------------------------------------
|
||||
`distribution` |String|`goreleaser` |GoReleaser distribution, either `goreleaser` or `goreleaser-pro`
|
||||
`version`[^version]|String|`latest` |GoReleaser version
|
||||
`args` |String| |Arguments to pass to GoReleaser
|
||||
`workdir` |String|`$(Build.SourcesDirectory)`|Working directory (below repository root)
|
||||
`installOnly` |Bool |`false` |Just install GoReleaser
|
||||
| Name | Type | Default | Description |
|
||||
| ------------------- | ------ | --------------------------- | ---------------------------------------------------------------- |
|
||||
| `distribution` | String | `goreleaser` | GoReleaser distribution, either `goreleaser` or `goreleaser-pro` |
|
||||
| `version`[^version] | String | `latest` | GoReleaser version |
|
||||
| `args` | String | | Arguments to pass to GoReleaser |
|
||||
| `workdir` | String | `$(Build.SourcesDirectory)` | Working directory (below repository root) |
|
||||
| `installOnly` | Bool | `false` | Just install GoReleaser |
|
||||
|
||||
[^version]: Can be a fixed version like `v1.10.0` or a max satisfying semver one
|
||||
[^version]:
|
||||
Can be a fixed version like `v1.10.0` or a max satisfying semver one
|
||||
like `~> v1.10`. In this case this will return the latest patch release of
|
||||
`v1.10`. For the `pro` version, add `-pro` to the string
|
||||
|
||||
### Task environment variables
|
||||
|
||||
```yaml
|
||||
...
|
||||
|
||||
---
|
||||
variables:
|
||||
- name: GORELEASER_KEY
|
||||
value: xxx
|
||||
...
|
||||
|
||||
---
|
||||
or short:
|
||||
|
||||
...
|
||||
---
|
||||
variables:
|
||||
GORELEASER_KEY: xxx
|
||||
...
|
||||
```
|
||||
|
||||
Following environment variables can be used, as environment variable.
|
||||
|
||||
Name |Description
|
||||
----------------|------------------------------------------------------------------------------------------------------------------------------------------
|
||||
`GITHUB_TOKEN` |[GITHUB_TOKEN](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) for e.g. `brew`
|
||||
`GORELEASER_KEY`|Your [GoReleaser Pro](https://goreleaser.com/pro) License Key, in case you are using the `goreleaser-pro` distribution
|
||||
| Name | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `GITHUB_TOKEN` | [GITHUB_TOKEN](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) for e.g. `brew` |
|
||||
| `GORELEASER_KEY` | Your [GoReleaser Pro](https://goreleaser.com/pro) License Key, in case you are using the `goreleaser-pro` distribution |
|
||||
|
||||
### Example pipeline
|
||||
|
||||
@ -101,10 +100,10 @@ jobs:
|
||||
|
||||
- task: goreleaser@0
|
||||
inputs:
|
||||
version: 'latest'
|
||||
distribution: 'goreleaser'
|
||||
args: ''
|
||||
workdir: '$(Build.SourcesDirectory)'
|
||||
version: "latest"
|
||||
distribution: "goreleaser"
|
||||
args: ""
|
||||
workdir: "$(Build.SourcesDirectory)"
|
||||
```
|
||||
|
||||
In this example a `Test` job is used to run `go test ./...` to first make sure that there're no failing tests. Only if
|
||||
|
@ -80,5 +80,5 @@ data:
|
||||
value: "your token here"
|
||||
```
|
||||
|
||||
Check [Managing Secrets](https://docs.semaphoreci.com/article/51-secrets-yaml-reference)
|
||||
Check [Managing Secrets](https://docs.semaphoreci.com/using-semaphore/secrets)
|
||||
for more detailed documentation.
|
||||
|
@ -63,7 +63,7 @@ If none are set, they default to GitLab's public URLs.
|
||||
|
||||
GitLab introduced the [Generic Package Registry](https://docs.gitlab.com/ee/user/packages/package_registry/index.html) in Gitlab 13.5.
|
||||
|
||||
Normally, `goreleaser` uploads release files as "attachments", which may have [administrative limits](https://docs.gitlab.com/ee/user/admin_area/settings/account_and_limit_settings.html).
|
||||
Normally, `goreleaser` uploads release files as "attachments", which may have [administrative limits](https://docs.gitlab.com/ee/administration/settings/account_and_limit_settings.html).
|
||||
Notably, hosted GitLab instances have a 10MB attachment limit, which cannot be changed.
|
||||
|
||||
Uploading to the Generic Package Registry does not have this restriction.
|
||||
|
@ -14,6 +14,9 @@ IgnoreURLs:
|
||||
- twitter.com
|
||||
- x.com
|
||||
- medium.com
|
||||
- gofi.sh
|
||||
- visualstudio.com
|
||||
- iron.security
|
||||
IgnoreDirs:
|
||||
- overrides
|
||||
IgnoreDirectoryMissingTrailingSlash: true
|
||||
|
Loading…
Reference in New Issue
Block a user