docs(releaser): fix repo URLs and add repository link
All git.k3nny.fr/releaser links were missing the /k3nny/ namespace. Fixed in docs/hugo.toml (geekdocRepo + geekdocEditPath), installation, ci-integration, and changelog pages. Also added repo link to the docs home page and README. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
A CI-friendly release automation tool for GitFlow workflows using Conventional Commits.
|
A CI-friendly release automation tool for GitFlow workflows using Conventional Commits.
|
||||||
|
|
||||||
**[Documentation](https://releaser.k3nny.fr)**
|
**[Documentation](https://releaser.k3nny.fr)** · **[Repository](https://git.k3nny.fr/k3nny/releaser)**
|
||||||
|
|
||||||
## Problem
|
## Problem
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ title: releaser
|
|||||||
|
|
||||||
**CI-friendly release automation for GitFlow workflows using Conventional Commits.**
|
**CI-friendly release automation for GitFlow workflows using Conventional Commits.**
|
||||||
|
|
||||||
|
[Source code](https://git.k3nny.fr/k3nny/releaser) · [Releases](https://git.k3nny.fr/k3nny/releaser/releases)
|
||||||
|
|
||||||
Standard tools like `semantic-release` are designed for trunk-based development. In a GitFlow setup with versioned release branches (`release/1.1`, `release/1.2`), they either fail to respect the branch's version range or require brittle configuration.
|
Standard tools like `semantic-release` are designed for trunk-based development. In a GitFlow setup with versioned release branches (`release/1.1`, `release/1.2`), they either fail to respect the branch's version range or require brittle configuration.
|
||||||
|
|
||||||
`releaser` is built for this exact workflow: it reads the branch name to pin the `major.minor`, parses Conventional Commits to determine the patch increment, and handles everything from `pom.xml` / `package.json` update to GitLab/GitHub tag and release creation.
|
`releaser` is built for this exact workflow: it reads the branch name to pin the `major.minor`, parses Conventional Commits to determine the patch increment, and handles everything from `pom.xml` / `package.json` update to GitLab/GitHub tag and release creation.
|
||||||
|
|||||||
@@ -73,4 +73,4 @@ weight: 50
|
|||||||
|
|
||||||
## v1.0 and earlier
|
## v1.0 and earlier
|
||||||
|
|
||||||
See the [full CHANGELOG](https://git.k3nny.fr/releaser/src/branch/main/CHANGELOG.md) in the repository.
|
See the [full CHANGELOG](https://git.k3nny.fr/k3nny/releaser/src/branch/main/CHANGELOG.md) in the repository.
|
||||||
|
|||||||
@@ -83,7 +83,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
curl -sSL https://git.k3nny.fr/releaser/releases/latest/download/releaser-linux-amd64 \
|
curl -sSL https://git.k3nny.fr/k3nny/releaser/releases/latest/download/releaser-linux-amd64 \
|
||||||
-o /usr/local/bin/releaser
|
-o /usr/local/bin/releaser
|
||||||
chmod +x /usr/local/bin/releaser
|
chmod +x /usr/local/bin/releaser
|
||||||
releaser
|
releaser
|
||||||
|
|||||||
@@ -5,11 +5,11 @@ weight: 10
|
|||||||
|
|
||||||
## Pre-built binaries
|
## Pre-built binaries
|
||||||
|
|
||||||
Download the latest release for your platform from the [Releases page](https://git.k3nny.fr/releaser/releases).
|
Download the latest release for your platform from the [Releases page](https://git.k3nny.fr/k3nny/releaser/releases).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Linux (amd64)
|
# Linux (amd64)
|
||||||
curl -sSL https://git.k3nny.fr/releaser/releases/download/v1.5.0/releaser-v1.5.0-linux-amd64 \
|
curl -sSL https://git.k3nny.fr/k3nny/releaser/releases/download/v1.5.0/releaser-v1.5.0-linux-amd64 \
|
||||||
-o /usr/local/bin/releaser
|
-o /usr/local/bin/releaser
|
||||||
chmod +x /usr/local/bin/releaser
|
chmod +x /usr/local/bin/releaser
|
||||||
```
|
```
|
||||||
@@ -19,13 +19,13 @@ Available platforms: `linux-amd64`, `linux-arm64`, `darwin-amd64`, `darwin-arm64
|
|||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull git.k3nny.fr/releaser/releaser:latest
|
docker pull git.k3nny.fr/k3nny/releaser/releaser:latest
|
||||||
|
|
||||||
# Run in the current repository
|
# Run in the current repository
|
||||||
docker run --rm \
|
docker run --rm \
|
||||||
-v "$PWD:/repo" \
|
-v "$PWD:/repo" \
|
||||||
-e GITLAB_TOKEN="$GITLAB_TOKEN" \
|
-e GITLAB_TOKEN="$GITLAB_TOKEN" \
|
||||||
git.k3nny.fr/releaser/releaser:latest
|
git.k3nny.fr/k3nny/releaser/releaser:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
## Build from source
|
## Build from source
|
||||||
@@ -33,7 +33,7 @@ docker run --rm \
|
|||||||
Requires Go 1.21+.
|
Requires Go 1.21+.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.k3nny.fr/releaser/releaser.git
|
git clone https://git.k3nny.fr/k3nny/releaser/releaser.git
|
||||||
cd releaser
|
cd releaser
|
||||||
go build -o /usr/local/bin/releaser ./cmd
|
go build -o /usr/local/bin/releaser ./cmd
|
||||||
```
|
```
|
||||||
|
|||||||
+1
-1
@@ -14,7 +14,7 @@ pygmentsCodeFences = true
|
|||||||
|
|
||||||
[params]
|
[params]
|
||||||
geekdocLogo = "images/releaser-logo-1024.png"
|
geekdocLogo = "images/releaser-logo-1024.png"
|
||||||
geekdocRepo = "https://git.k3nny.fr/releaser"
|
geekdocRepo = "https://git.k3nny.fr/k3nny/releaser"
|
||||||
geekdocEditPath = "edit/main/docs/content"
|
geekdocEditPath = "edit/main/docs/content"
|
||||||
geekdocSearch = true
|
geekdocSearch = true
|
||||||
geekdocMenuBundle = true
|
geekdocMenuBundle = true
|
||||||
|
|||||||
Reference in New Issue
Block a user