Skip to content

Commit

Permalink
docs: Mention Gitea explicitly in packaging
Browse files Browse the repository at this point in the history
The AUR, Homebrew and Scoop can all support pulling from Gitea

Signed-off-by: Sam Therapy <sam@samtherapy.net>
  • Loading branch information
SamTherapy committed Oct 21, 2022
1 parent b9177e0 commit 476dbf6
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 29 deletions.
27 changes: 13 additions & 14 deletions www/docs/customization/aur.md
Expand Up @@ -2,20 +2,19 @@

Since: v1.4.

After releasing to GitHub or GitLab, GoReleaser can generate and publish
After releasing to GitHub, GitLab, or Gitea, GoReleaser can generate and publish
a `PKGBUILD` to an _Arch User Repository_.

!!! warning
Before going further on this, make sure to read
[AUR's Submission Guidelines](https://wiki.archlinux.org/title/AUR_submission_guidelines).
Before going further on this, make sure to read
[AUR's Submission Guidelines](https://wiki.archlinux.org/title/AUR_submission_guidelines).

This page describes the available options.

```yaml
# .goreleaser.yaml
aurs:
-
# The package name.
- # The package name.
#
# Defaults to the Project Name with a -bin suffix.
#
Expand All @@ -42,12 +41,12 @@ aurs:
# The maintainers of the package.
# Defaults to empty.
maintainers:
- 'Foo Bar <foo at bar dot com>'
- "Foo Bar <foo at bar dot com>"

# The contributors of the package.
# Defaults to empty.
contributors:
- 'Foo Zaz <foo at zaz dot com>'
- "Foo Zaz <foo at zaz dot com>"

# SPDX identifier of your app's license.
# Default is empty.
Expand All @@ -57,12 +56,12 @@ aurs:
# This can either be a path or the key contents.
#
# WARNING: do not expose your private key in the configuration file!
private_key: '{{ .Env.AUR_KEY }}'
private_key: "{{ .Env.AUR_KEY }}"

# The AUR Git URL for this package.
# Defaults to empty
# Publish is skipped if empty.
git_url: 'ssh://aur@aur.archlinux.org/mypackage-bin.git'
git_url: "ssh://aur@aur.archlinux.org/mypackage-bin.git"

# Setting this will prevent goreleaser to actually try to commit the updated
# formula - instead, the formula file will be stored on the dist folder only,
Expand Down Expand Up @@ -99,7 +98,7 @@ aurs:
#
# Defaults to empty.
optdepends:
- 'wget: for downloading things'
- "wget: for downloading things"

# List of files that can contain user-made changes and should be preserved
# during package upgrades and removals.
Expand Down Expand Up @@ -153,7 +152,7 @@ aurs:
# the Git URL.
#
# Defaults to `ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null`.
git_ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'
git_ssh_command: "ssh -i {{ .Env.KEY }} -o SomeOption=yes"

# Template for the url which is determined by the given Token
# (github, gitlab or gitea).
Expand All @@ -163,8 +162,8 @@ aurs:
```

!!! tip
Learn more about the [name template engine](/customization/templates/).
Learn more about the [name template engine](/customization/templates/).

!!! tip
For more info about what each field does, please refer to
[Arch's PKGBUILD reference](https://wiki.archlinux.org/title/PKGBUILD).
For more info about what each field does, please refer to
[Arch's PKGBUILD reference](https://wiki.archlinux.org/title/PKGBUILD).
12 changes: 6 additions & 6 deletions www/docs/customization/homebrew.md
@@ -1,6 +1,6 @@
# Homebrew Taps

After releasing to GitHub or GitLab, GoReleaser can generate and publish
After releasing to GitHub, GitLab, or Gitea, GoReleaser can generate and publish
a _homebrew-tap_ recipe into a repository that you have access to.

The `brews` section specifies how the formula should be created.
Expand Down Expand Up @@ -168,7 +168,7 @@ brews:
```

!!! tip
Learn more about the [name template engine](/customization/templates/).
Learn more about the [name template engine](/customization/templates/).

By defining the `brew` section, GoReleaser will take care of publishing the
Homebrew tap.
Expand Down Expand Up @@ -215,10 +215,10 @@ end
```

!!! info
Note that GoReleaser does not generate a valid homebrew-core formula.
The generated formulas are meant to be published as
[homebrew taps](https://docs.brew.sh/Taps.html), and in their current
form will not be accepted in any of the official homebrew repositories.
Note that GoReleaser does not generate a valid homebrew-core formula.
The generated formulas are meant to be published as
[homebrew taps](https://docs.brew.sh/Taps.html), and in their current
form will not be accepted in any of the official homebrew repositories.

## Head Formulas

Expand Down
14 changes: 6 additions & 8 deletions www/docs/customization/scoop.md
@@ -1,6 +1,6 @@
# Scoop Manifests

After releasing to GitHub or GitLab, GoReleaser can generate and publish a
After releasing to GitHub, GitLab, or Gitea, GoReleaser can generate and publish a
_Scoop App Manifest_ into a repository that you have access to.

The `scoop` section specifies how the manifest should be created. See the
Expand All @@ -9,7 +9,7 @@ commented example below:
```yaml
# .goreleaser.yaml
scoop:
# Template for the url which is determined by the given Token (github or gitlab)
# Template for the url which is determined by the given Token (github, gitlab or gitea)
# Default for github is "https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
# Default for gitlab is "https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}"
# Default for gitea is "https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
Expand Down Expand Up @@ -62,8 +62,8 @@ scoop:

# Persist data between application updates
persist:
- "data"
- "config.toml"
- "data"
- "config.toml"

# An array of commands to be executed before an application is installed.
# Default is empty.
Expand All @@ -89,14 +89,12 @@ the root of the repository specified in the `bucket` section.
"version": "1.2.3",
"architecture": {
"64bit": {
"url":
"https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_amd64.tar.gz",
"url": "https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_amd64.tar.gz",
"bin": "drumroll.exe",
"hash": "86920b1f04173ee08773136df31305c0dae2c9927248ac259e02aafd92b6008a"
},
"32bit": {
"url":
"https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_386.tar.gz",
"url": "https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_386.tar.gz",
"bin": "drumroll.exe",
"hash": "283faa524ef41987e51c8786c61bb56658a489f63512b32139d222b3ee1d18e6"
}
Expand Down
2 changes: 1 addition & 1 deletion www/docs/scm/gitea.md
Expand Up @@ -24,7 +24,7 @@ the `.goreleaser.yaml` configuration file. This takes a normal string, or a temp
```yaml
# .goreleaser.yaml
gitea_urls:
api: https://gitea.myinstance.com/api/v1/
api: https://gitea.myinstance.com/api/v1
download: https://gitea.myinstance.com
# set to true if you use a self-signed certificate
skip_tls_verify: false
Expand Down

0 comments on commit 476dbf6

Please sign in to comment.