mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-17 20:47:50 +02:00
docs: improvements
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
This commit is contained in:
parent
890a606ede
commit
fcce525a56
@ -132,7 +132,7 @@ Following environment variables can be used as `step.env` keys
|
||||
|----------------|-------------------------------------------------------|
|
||||
| `GITHUB_TOKEN` | [GITHUB_TOKEN][github-token] as provided by `secrets` |
|
||||
|
||||
## Limitation
|
||||
## Limitations
|
||||
|
||||
`GITHUB_TOKEN` permissions [are limited to the repository][about-github-token] that contains your workflow.
|
||||
|
||||
@ -151,6 +151,17 @@ create a secret named `GH_PAT`, the step will look like this:
|
||||
GITHUB_TOKEN: ${{ secrets.GH_PAT }}
|
||||
```
|
||||
|
||||
## How does it look like?
|
||||
|
||||
You can check [this example repository](https://github.com/goreleaser/example) for a real world example.
|
||||
|
||||
<a href="https://github.com/goreleaser/example/releases">
|
||||
<figure>
|
||||
<img src="https://img.carlosbecker.dev/goreleaser-github.png"/>
|
||||
<figcaption>Example release on GitHub.</figcaption>
|
||||
</figure>
|
||||
</a>
|
||||
|
||||
[goreleaser-action]: https://github.com/goreleaser/goreleaser-action
|
||||
[actions]: https://github.com/features/actions
|
||||
[syntax]: https://help.github.com/en/articles/workflow-syntax-for-github-actions#About-yaml-syntax-for-workflows
|
||||
|
@ -69,3 +69,14 @@ dockers:
|
||||
- 'registry.gitlab.com/Group/Project:{{ .Tag }}'
|
||||
- 'registry.gitlab.com/Group/Project:latest'
|
||||
```
|
||||
|
||||
## How does it look like?
|
||||
|
||||
You can check [this example repository](https://gitlab.com/goreleaser/example) for a real world example.
|
||||
|
||||
<a href="https://gitlab.com/goreleaser/example/-/releases">
|
||||
<figure>
|
||||
<img src="https://img.carlosbecker.dev/goreleaser-gitlab.png"/>
|
||||
<figcaption>Example release on GitLab.</figcaption>
|
||||
</figure>
|
||||
</a>
|
||||
|
@ -83,19 +83,24 @@ Now you can run GoReleaser at the root of your repository:
|
||||
goreleaser
|
||||
```
|
||||
|
||||
That's all! Check your GitHub project's release page.
|
||||
The release should look like this:
|
||||
That's all!
|
||||
|
||||
<a href="https://github.com/goreleaser/goreleaser/releases">
|
||||
<img width="100%"
|
||||
src="https://cloud.githubusercontent.com/assets/245435/23342061/fbcbd506-fc31-11e6-9d2b-4c1b776dee9c.png">
|
||||
Check your GitHub project's releases page!
|
||||
|
||||
<a href="https://github.com/goreleaser/example/releases">
|
||||
<figure>
|
||||
<img src="https://img.carlosbecker.dev/goreleaser-github.png"/>
|
||||
<figcaption>Example release on GitHub.</figcaption>
|
||||
</figure>
|
||||
</a>
|
||||
|
||||
Or check your GitLab project's release page.
|
||||
The release should also look like this:
|
||||
<a href="https://gitlab.com/mavogel/release-testing/-/releases">
|
||||
<img width="100%"
|
||||
src="https://user-images.githubusercontent.com/8409778/59390011-55fcdf80-8d70-11e9-840f-c568ddc0e965.png">
|
||||
Or, if you released to GitLab, check it out too!
|
||||
|
||||
<a href="https://gitlab.com/goreleaser/example/-/releases">
|
||||
<figure>
|
||||
<img src="https://img.carlosbecker.dev/goreleaser-gitlab.png"/>
|
||||
<figcaption>Example release on GitLab.</figcaption>
|
||||
</figure>
|
||||
</a>
|
||||
|
||||
!!! note
|
||||
|
Loading…
x
Reference in New Issue
Block a user