From f636cfc5ce0fdbe07d9010c1690876abcc017d29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20H=C3=A5rek=20Andreassen?= Date: Sat, 20 Apr 2024 16:57:04 +0200 Subject: [PATCH] docs(website): Add SourceHut builds example (#617) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Add SourceHut builds example Signed-off-by: Tim Hårek Andreassen * docs: polish SourceHut docs --------- Signed-off-by: Tim Hårek Andreassen Co-authored-by: Orhun Parmaksız --- website/docs/sourcehut.md | 43 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 website/docs/sourcehut.md diff --git a/website/docs/sourcehut.md b/website/docs/sourcehut.md new file mode 100644 index 0000000000..d903e537f3 --- /dev/null +++ b/website/docs/sourcehut.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 11 +--- + +# Sourcehut Builds + +It is possible to generate changelogs using [SourceHut builds](https://builds.sr.ht). + +```yaml +image: alpine/edge +packages: + - git-cliff +secrets: + - +sources: + - git://git@git.sr.ht:~/ +environment: + dir: + source: +tasks: + - git-cliff: | + cd $dir + cd $dir + git cliff -o CHANGELOG.md + ssh-keyscan -t rsa git.sr.ht >> ~/.ssh/known_hosts + git remote set-url origin $source + git checkout main + git add CHANGELOG.md + git commit -m "chore(release): Update CHANGELOG" + git push -o skip-ci +``` + +1. Generate a new SSH-key for SourceHut builds: + `ssh-keygen -t ed25519 -C "builds.sr.ht" -f ~/.ssh/builds-srht` +2. Add the newly generated public key to your + [SourceHut account](https://meta.sr.ht/keys). +3. Add the private key as a secret to your + [Sourcehut Builds](https://builds.sr.ht/secrets). +4. Replace all the placeholders in your `.build.yml`: + - `` + - `` + - `` + - ``