|
@@ -4,24 +4,25 @@ Branch `feature/rekopub-import` · no version change (the code is the same as th
|
|
|
|
|
|
|
|
## What changed
|
|
## What changed
|
|
|
|
|
|
|
|
-- **Whole project imported** from the previous repository's latest `main`: the CLI, `internal/` packages, tests and test data, `PLAN.md`, `SECURITY.md`, `build.cmd`, `test-examples.cmd`, the GoReleaser config and the GitHub workflow files. It's a single commit with no earlier history, so the old name only survives in the old repository.
|
|
|
|
|
|
|
+- **Whole project imported** from the previous repository's latest `main`: the CLI, `internal/` packages, tests and test data, `PLAN.md`, `SECURITY.md`, `build.cmd`, `test-examples.cmd` and the GoReleaser config. It's a single commit with no earlier history, so the old name only survives in the old repository.
|
|
|
- **Renamed to ReKoPub.** The project is called ReKoPub in prose and `rekopub` in code: the binary, `cmd/rekopub/`, the usage text, `-VERSION` output, the user agent (`compatible; rekopub`), error messages, the internal stand-in host for image URLs (`rekopub.invalid`), the build scripts, GoReleaser archive names and `.gitignore`.
|
|
- **Renamed to ReKoPub.** The project is called ReKoPub in prose and `rekopub` in code: the binary, `cmd/rekopub/`, the usage text, `-VERSION` output, the user agent (`compatible; rekopub`), error messages, the internal stand-in host for image URLs (`rekopub.invalid`), the build scripts, GoReleaser archive names and `.gitignore`.
|
|
|
- **New module path** `git.monoexp.com/bajdev/rekopub` (Gogs answers `?go-get=1` for it), so `go install git.monoexp.com/bajdev/rekopub/cmd/rekopub@latest` works. Clone and Releases links in the README point to `git.monoexp.com/bajdev/ReKoPub`.
|
|
- **New module path** `git.monoexp.com/bajdev/rekopub` (Gogs answers `?go-get=1` for it), so `go install git.monoexp.com/bajdev/rekopub/cmd/rekopub@latest` works. Clone and Releases links in the README point to `git.monoexp.com/bajdev/ReKoPub`.
|
|
|
- **`LICENSE`**: the Gogs template's `<year> <copyright holders>` placeholder is replaced by the project's MIT licence, `Copyright (c) 2026 bajdev`.
|
|
- **`LICENSE`**: the Gogs template's `<year> <copyright holders>` placeholder is replaced by the project's MIT licence, `Copyright (c) 2026 bajdev`.
|
|
|
- **`README.md`**: the project README replaces the Gogs placeholder, keeping its "Turn any web article into a clean EPUB for your e-ink reader" tagline.
|
|
- **`README.md`**: the project README replaces the Gogs placeholder, keeping its "Turn any web article into a clean EPUB for your e-ink reader" tagline.
|
|
|
|
|
+- **GitHub-only files removed:** the CI and Release workflows (`.github/workflows/`), which don't run on Gogs.
|
|
|
|
|
+- **Releases are built locally:** `.goreleaser.yaml` takes its changelog from git instead of GitHub and no longer publishes a release; it writes the archives and checksums to `dist/`. The README's "Releasing" section now says to run govulncheck, tag, run `goreleaser release --clean` and attach the files from `dist/` to a Gogs release. The lines saying CI runs epubcheck are gone.
|
|
|
- **`pull-releases/`**: this record and the index, started with this PR.
|
|
- **`pull-releases/`**: this record and the index, started with this PR.
|
|
|
|
|
|
|
|
## Notes
|
|
## Notes
|
|
|
|
|
|
|
|
-These still describe GitHub and need a decision before the next release:
|
|
|
|
|
-
|
|
|
|
|
-- `.github/workflows/` (CI and Release) don't run on Gogs. The README's "Releasing" section and the "CI always runs them" line describe them.
|
|
|
|
|
-- `.goreleaser.yaml` takes its changelog from GitHub and creates a draft GitHub release. Gogs can't receive GoReleaser uploads, so archives would have to be built locally and attached to a Gogs release by hand.
|
|
|
|
|
-- `SECURITY.md` asks for reports through GitHub's Security tab, which Gogs doesn't have.
|
|
|
|
|
|
|
+- Without CI, nothing runs the checks automatically: gofmt, vet, staticcheck, govulncheck, epubcheck and the Windows and macOS test runs are now done by hand.
|
|
|
|
|
+- `SECURITY.md` still asks for reports through GitHub's Security tab, which Gogs doesn't have. It needs a contact before the next release.
|
|
|
|
|
+- `PLAN.md` is left as written: its CI and GitHub release lines describe how the project was originally planned.
|
|
|
|
|
|
|
|
## Testing
|
|
## Testing
|
|
|
|
|
|
|
|
- `gofmt -l .` is clean; `go vet ./...` passes; `go test ./...` passes (epubcheck checks skipped: no `EPUBCHECK_JAR`).
|
|
- `gofmt -l .` is clean; `go vet ./...` passes; `go test ./...` passes (epubcheck checks skipped: no `EPUBCHECK_JAR`).
|
|
|
- `go build -ldflags "-X main.version=dev" ./cmd/rekopub`, then `rekopub -VERSION` prints `rekopub dev` and `-h` shows `Usage: rekopub …`.
|
|
- `go build -ldflags "-X main.version=dev" ./cmd/rekopub`, then `rekopub -VERSION` prints `rekopub dev` and `-h` shows `Usage: rekopub …`.
|
|
|
- Converted `https://en.wikipedia.org/wiki/E_Ink` to `e-ink-wikipedia.epub` (309 KB). No file in the book contains the old name.
|
|
- Converted `https://en.wikipedia.org/wiki/E_Ink` to `e-ink-wikipedia.epub` (309 KB). No file in the book contains the old name.
|
|
|
|
|
+- `goreleaser check` passes. `goreleaser release --snapshot --clean` builds all six archives (Windows, macOS and Linux on amd64 and arm64) plus `checksums.txt`, publishing nothing; each archive holds `rekopub`, `README.md` and `LICENSE`.
|
|
|
- A case-insensitive search for the old name across the repository finds nothing.
|
|
- A case-insensitive search for the old name across the repository finds nothing.
|