Skip to content

Commit

Permalink
docs(website): Add SourceHut builds example (#617)
Browse files Browse the repository at this point in the history
* docs: Add SourceHut builds example

Signed-off-by: Tim Hårek Andreassen <tim@harek.no>

* docs: polish SourceHut docs

---------

Signed-off-by: Tim Hårek Andreassen <tim@harek.no>
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
  • Loading branch information
timharek and orhun committed Apr 20, 2024
1 parent 1581b40 commit f636cfc
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions website/docs/sourcehut.md
Original file line number Diff line number Diff line change
@@ -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:
- <your-builds.sr.ht-secret>
sources:
- git://git@git.sr.ht:~<username>/<repo-name>
environment:
dir: <repo-name>
source: <your-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`:
- `<your-builds.sr.ht-secret>`
- `<username>`
- `<repo-name>`
- `<your-source>`

0 comments on commit f636cfc

Please sign in to comment.