QOwnNotes/justfile at main · pbek/QOwnNotes · GitHub

History

277 lines (223 loc) · 8.89 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

# Use `just <recipe>` to run a recipe

# https://just.systems/man/en/

import ".shared/common.just"

# By default, run the `--list` command

default:

@just --list

# Variables

transferDir := `if [ -d "$HOME/NextcloudPrivate/Transfer" ]; then echo "$HOME/NextcloudPrivate/Transfer"; else echo "$HOME/Nextcloud/Transfer"; fi`

sourceBuildDir := "build-QOwnNotes"

sourceBuildTestDir := "build-tests-QOwnNotes"

# Aliases

alias fix-linting := clang-format

alias linter-fix := clang-format

alias fix-cmake-format := cmake-format-fix

alias trace-process := process-trace

alias test := src-test

alias download-translations := translations-download

# Build the Docker compose images for build systems

[group('build-systems')]

build-systems-docker-build:

cd build-systems && docker compose build

# Build the translations

[group('translations')]

translations-build:

lrelease src/QOwnNotes.pro

# Download the translations from Crowdin

[group('translations')]

translations-download: translations-changelog

./scripts/download_translations.sh

# Generate a changelog line for recent Crowdin translation contributions

[group('translations')]

translations-changelog args='':

python3 ./scripts/crowdin_translation_changelog.py {{ args }}

# Upload the translations to Crowdin

[group('translations')]

translations-upload:

crowdin upload

# Update the translations files

[group('translations')]

translations-update-files:

./scripts/update-translations.sh

# Build the application for nix

[group('nix')]

nix-build:

nix build '.?submodules=1#qownnotes-qt6'

# Build the application for nix with QLITEHTML support

[group('nix')]

nix-build-qlitehtml:

nix build '.?submodules=1#qownnotes-qt6-qlitehtml'

# Build the application for nix for aaarch64 (throws errors while building Qt6)

[group('nix')]

nix-build-aarch64:

nix-build -E '((import <nixpkgs> {}).pkgsCross.aarch64-multiplatform.qt6Packages.callPackage (import ./default.nix) { })'

# Build the application with cmake and Qt5 for nix

[group('nix')]

nix-build-cmake-qt5:

nix-build -E 'let pkgs = import <nixpkgs> {}; in pkgs.libsForQt5.callPackage (import ./build-systems/nix/default-cmake-qt5.nix) { }'

# Build the application with Qt5 for nix

[group('nix')]

nix-build-qt5:

nix build '.?submodules=1#qownnotes-qt5'

# Build the application with Qt 5.15.3 for nix

[group('nix')]

nix-build-qt5153:

nix build '.?submodules=1#qownnotes-qt5153'

# Force a rebuild of the application with Qt5 for nix

[group('nix')]

nix-build-qt5-force:

nix build '.?submodules=1#qownnotes-qt5' --rebuild

# Force a rebuild of the application with Qt 5.15.3 for nix

[group('nix')]

nix-build-qt5153-force:

nix build '.?submodules=1#qownnotes-qt5153' --rebuild

# Build the application with Qt 6.9 for nix

[group('nix')]

nix-build-qt69 args='':

nix build '.?submodules=1#qownnotes-qt69' {{ args }}

# Build the application with Qt6 for nix with a trace

[group('nix')]

nix-build-trace:

nix build '.?submodules=1#qownnotes-qt6' --show-trace

# Force a rebuild of the application with Qt6 for nix

[group('nix')]

nix-build-force:

nix build '.?submodules=1#qownnotes-qt6' --rebuild

# Run the built application for nix

[group('nix')]

nix-run:

./result/bin/QOwnNotes --session test

# Build and run the application for nix

[group('nix')]

nix-build-run: nix-build nix-run

# Open the breeze icons folder

[group('nix')]

open-breeze-icons:

xdg-open /run/current-system/sw/share/icons/breeze

# Build the application direclty from the source

[group('src-build')]

src-build:

qmake --version

mkdir -p {{ sourceBuildDir }}; cd {{ sourceBuildDir }} && qmake "CONFIG+=debug USE_SYSTEM_BOTAN=1" ../src/QOwnNotes.pro CONFIG+=DEV_MODE && make -j$(nproc)

# Build the application direclty from the source

[group('src-build')]

src-build-internal-botan:

qmake --version

mkdir -p {{ sourceBuildDir }}; cd {{ sourceBuildDir }} && qmake "CONFIG+=debug" ../src/QOwnNotes.pro CONFIG+=DEV_MODE && make -j$(nproc)

# Build the application direclty from the source

[group('src-build')]

src-test:

mkdir -p {{ sourceBuildTestDir }}; cd {{ sourceBuildTestDir }} && qmake CONFIG+=debug CONFIG+=DEV_MODE DEFINES+=INTEGRATION_TESTS ../tests/QOwnNotesTests.pro && make -j$(nproc)

./bin/tests/tests -platform minimal

rm -rf {{ sourceBuildTestDir }}

# Clean the build directory

[group('src-build')]

src-clean:

rm -rf {{ sourceBuildDir }}

# Run the built application

[group('src-build')]

src-run:

@if [ "$(uname)" = "Darwin" ]; then \

./{{ sourceBuildDir }}/QOwnNotes.app/Contents/MacOS/QOwnNotes; \

else \

./{{ sourceBuildDir }}/QOwnNotes; \

# Build and run the application

[group('src-build')]

src-build-run: src-build src-run

# Do a clang format on the project

[group('linter')]

clang-format:

./scripts/clang-format-project.sh

# Fix formatting of the source CMake file

[group('linter')]

cmake-format-fix:

cmake-format -i src/CMakeLists.txt

# Check links in the markdown files

[group('linter')]

link-check:

nix-shell -p lychee --run "lychee './**/*.md'"

# Apply a git patch to the project

[group('patches')]

git-apply-qownnotes-patch:

git apply {{ transferDir }}/qownnotes.patch

# Apply a git patch to qmarkdowntextedit

[group('patches')]

git-apply-qmarkdowntextedit-patch:

cd ./src/libraries/qmarkdowntextedit && git apply {{ transferDir }}/qmarkdowntextedit.patch

# Apply a git patch to qhotkey

[group('patches')]

git-apply-qhotkey-patch:

cd ./src/libraries/qhotkey && git apply {{ transferDir }}/qhotkey.patch

# Apply a git patch to piwiktracker

[group('patches')]

git-apply-piwiktracker-patch:

cd ./src/libraries/piwiktracker && git apply {{ transferDir }}/piwiktracker.patch

# Apply a git patch to qttoolbareditor

[group('patches')]

git-apply-qttoolbareditor-patch:

cd ./src/libraries/qttoolbareditor && git apply {{ transferDir }}/qttoolbareditor.patch

# Create git patches for the project and some libraries

[group('patches')]

git-create-patches:

@echo "transferDir: {{ transferDir }}"

git diff --no-ext-diff --staged --binary > {{ transferDir }}/qownnotes.patch

cd src/libraries/qmarkdowntextedit && git diff --no-ext-diff --staged --binary > {{ transferDir }}/qmarkdowntextedit.patch

cd src/libraries/qhotkey && git diff --no-ext-diff --staged --binary > {{ transferDir }}/qhotkey.patch

cd src/libraries/piwiktracker && git diff --no-ext-diff --staged --binary > {{ transferDir }}/piwiktracker.patch

cd src/libraries/qttoolbareditor && git diff --no-ext-diff --staged --binary > {{ transferDir }}/qttoolbareditor.patch

ls -l1t {{ transferDir }} | head -6

# Open the Crowdin webpage

[group('translations')]

open-crowdin-webpage:

xdg-open https://crowdin.com/project/qownnotes/activity-stream

# Fix the settings.ui file after QtCreator has destroyed it

[group('linter')]

fix-settings-ui-file:

./scripts/fix-settings-ui-file.sh

# Attach to the QOwnNotes process with lurk

[group('debug')]

process-trace:

nix-shell -p lurk --run "sudo lurk --attach `procs QOwnNotes | fzf --height 40% --layout reverse | awk '{print $1}'`"

# Generate the icons for the whole project based on icons/icon.svg and icons/icon-dark.svg

[group('icons')]

generate-icons:

cd icons &&./generate-icons.sh

# Generate the SNAP_TOKEN_GH token for the snap GitHub release action (see https://github.com/canonical/action-publish)

[group('snap')]

snap-generate-token:

gum confirm "Generate a Snap Store token for qownnotes?" && cd build-systems && docker compose run --rm releaser snapcraft export-login --snaps=qownnotes --acls package_access,package_push,package_update,package_release -

# Run a GitHub workflow

[group('linter')]

run-github-workflow args='format-check':

nix-shell -p act --run "act -j {{ args }}"

# Build botan3 amalgamation

[group('maintenance')]

build-botan3-amalgamation:

nix-build -E 'with import <nixpkgs> {}; callPackage ./scripts/botan3-amalgamation.nix {}'

# Run the VM tests

[group('tests')]

vm-test:

nix build .?submodules=1#checks.x86_64-linux.qownnotes -L --no-link

# Run the interactive VM test

[group('tests')]

vm-test-interactive:

nix build .?submodules=1#checks.x86_64-linux.qownnotes.driverInteractive

echo "To interact with the test VM, run: start_all()"

./result/bin/nixos-test-driver

# Build the application with Qt6 for nix with submodules

[group('nix')]

nix-build-qt6:

nix build '.?submodules=1#qownnotes-qt6'

# Build the application with Qt6 for nix with submodules and QLITEHTML support

[group('nix')]

nix-build-qt6-qlitehtml:

nix build '.?submodules=1#qownnotes-qt6-qlitehtml'

# Force a rebuild of the application with Qt6 (submodules, new FORCE_REBUILD tag)

[group('nix')]

nix-build-qt6-force:

FORCE_REBUILD=$(date +%s) nix build '.?submodules=1#qownnotes-qt6' --impure --rebuild

# Force a rebuild of the application with Qt6 and QLITEHTML (submodules, new FORCE_REBUILD tag)

[group('nix')]

nix-build-qt6-qlitehtml-force:

FORCE_REBUILD=$(date +%s) nix build '.?submodules=1#qownnotes-qt6-qlitehtml' --impure --rebuild

QOwnNotes/justfile at main · pbek/QOwnNotes · GitHub

Uh oh!

Expand file tree

Breadcrumbs

justfile

Latest commit

History

Breadcrumbs

justfile

File metadata and controls