From 476dbf616ca462dbede8500c0e1a378a61cf7621 Mon Sep 17 00:00:00 2001 From: Sam Therapy Date: Fri, 21 Oct 2022 21:22:48 +0200 Subject: [PATCH] docs: Mention Gitea explicitly in packaging The AUR, Homebrew and Scoop can all support pulling from Gitea Signed-off-by: Sam Therapy --- www/docs/customization/aur.md | 27 +++++++++++++-------------- www/docs/customization/homebrew.md | 12 ++++++------ www/docs/customization/scoop.md | 14 ++++++-------- www/docs/scm/gitea.md | 2 +- 4 files changed, 26 insertions(+), 29 deletions(-) diff --git a/www/docs/customization/aur.md b/www/docs/customization/aur.md index 541a3bbc2a5f..de7b7a459b1f 100644 --- a/www/docs/customization/aur.md +++ b/www/docs/customization/aur.md @@ -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. # @@ -42,12 +41,12 @@ aurs: # The maintainers of the package. # Defaults to empty. maintainers: - - 'Foo Bar ' + - "Foo Bar " # The contributors of the package. # Defaults to empty. contributors: - - 'Foo Zaz ' + - "Foo Zaz " # SPDX identifier of your app's license. # Default is empty. @@ -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, @@ -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. @@ -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). @@ -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). diff --git a/www/docs/customization/homebrew.md b/www/docs/customization/homebrew.md index ebe94077735b..908b95b75f01 100644 --- a/www/docs/customization/homebrew.md +++ b/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. @@ -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. @@ -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 diff --git a/www/docs/customization/scoop.md b/www/docs/customization/scoop.md index 1d5518c6f4e5..446f4bae35cb 100644 --- a/www/docs/customization/scoop.md +++ b/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 @@ -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///releases/download/{{ .Tag }}/{{ .ArtifactName }}" # Default for gitlab is "https://gitlab.com///-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}" # Default for gitea is "https://gitea.com///releases/download/{{ .Tag }}/{{ .ArtifactName }}" @@ -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. @@ -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" } diff --git a/www/docs/scm/gitea.md b/www/docs/scm/gitea.md index e7152bbe63f7..d29e2a734746 100644 --- a/www/docs/scm/gitea.md +++ b/www/docs/scm/gitea.md @@ -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