Skip to content

Commit

Permalink
devops: Standardize Taskfile extensions (#4574)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
max-sixty and pre-commit-ci[bot] authored Jun 9, 2024
1 parent 16fd5b7 commit 7f46a6d
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"customizations": {
"vscode": {
"extensions": [
// Keep in sync with Taskfile.yml
// Keep in sync with Taskfile.yaml
"prql-lang.prql-vscode",
"rust-lang.rust-analyzer",
"mitsuhiko.insta",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-devcontainer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:

- name: Prep args
run: |
echo "cargo_crates=$(yq -r '.vars.cargo_crates' Taskfile.yml)" >>"$GITHUB_ENV"
echo "cargo_crates=$(yq -r '.vars.cargo_crates' Taskfile.yaml)" >>"$GITHUB_ENV"
- name: Build
uses: docker/build-push-action@v5
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ jobs:
- .github/workflows/test-dotnet.yaml
devcontainer-push:
- .devcontainer/**/*Dockerfile
- Taskfile.yml
- Taskfile.yaml
devcontainer-build:
- .devcontainer/**/*Dockerfile
- .github/workflows/build-devcontainer.yaml
- Taskfile.yml
- Taskfile.yaml
grammars:
- grammars/**
elixir:
Expand Down Expand Up @@ -119,7 +119,7 @@ jobs:
- web/book/**
- .github/workflows/test-rust.yaml
taskfile:
- Taskfile.yml
- Taskfile.yaml
web:
- "web/**"
- ".github/workflows/build-web.yaml"
Expand Down
2 changes: 1 addition & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"recommendations": [
// Keep in sync with Taskfile.yml
// Keep in sync with Taskfile.yaml
"prql-lang.prql-vscode",
"rust-lang.rust-analyzer",
"mitsuhiko.insta",
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ This release has 155 commits from 9 contributors. Selected changes:

- Rename some of the internal crates, and refactored their paths in the repo.
(@aljazerzen, #3683).
- Add a `justfile` for developers who prefer that above our `Taskfile.yml`
- Add a `justfile` for developers who prefer that above our `Taskfile.yaml`
(@aljazerzen, #3681)

**New Contributors**:
Expand Down
4 changes: 2 additions & 2 deletions Taskfile.yml → Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -384,8 +384,8 @@ tasks:
# The next two tasks are not used for either:
# - the Dockerfile (installing brew takes forever)
# so the Dockerfile simply installs hugo & nodejs directly
# - the "desktop setup" - it uses other tasks in the Taskfile.yml
# They remain in the Taskfile.yml as a hint if they should ever be needed
# - the "desktop setup" - it uses other tasks in the Taskfile.yaml
# They remain in the Taskfile.yaml as a hint if they should ever be needed

# install-hugo:
# cmds:
Expand Down
4 changes: 3 additions & 1 deletion lutra/Taskfile.yml → lutra/Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ tasks:
- cmd: cargo run --package lutra -- execute example-project

fmt:
desc: Format prqlc source files
desc:
Format prqlc source files (Duplicates `pre-commit` checks, but some
developers prefer to use this directly.)
cmds:
- cmd: |
# remove trailing whitespace
Expand Down
2 changes: 2 additions & 0 deletions lutra/bindings/python/Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ vars:
venv_dir: "../../../target/venv"

tasks:
# (Duplicates `pre-commit` checks, but some developers prefer to use this
# directly.)
fmt:
desc: "Format"
cmds:
Expand Down
4 changes: 2 additions & 2 deletions prqlc/Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ vars:
tasks:
fmt:
desc:
Format prqlc source files. Duplicates `pre-commit` checks, but some
developers prefer to use this directly.
Format prqlc source files. (Duplicates `pre-commit` checks, but some
developers prefer to use this directly.)
cmds:
- cmd: |
# remove trailing whitespace
Expand Down
1 change: 1 addition & 0 deletions web/Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ tasks:
- npm run dev

fmt:
# (Duplicates `pre-commit` checks, but some developers prefer to use this directly.)
cmds:
- cmd: |
prettier --write . \
Expand Down
2 changes: 1 addition & 1 deletion web/book/src/project/bindings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Supported bindings require:
[core compile functions](https://docs.rs/prqlc/latest/prqlc/#functions).
- Test coverage for these functions.
- A published package to the language's standard package repository.
- A script in `Taskfile.yml` to bootstrap a development environment.
- A script in `Taskfile.yaml` to bootstrap a development environment.
- Any dev tools, such as a linter & formatter, in pre-commit or MegaLinter.

The currently supported bindings are:
Expand Down
6 changes: 3 additions & 3 deletions web/book/src/project/contributing/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ since it relies on `brew`.

- [Install Task](https://taskfile.dev/installation/).
- Then run the `setup-dev` task. This runs commands from our
[Taskfile.yaml](https://github.com/PRQL/prql/blob/main/Taskfile.yaml),
[Taskfile.yaml](https://github.com/PRQL/prql/blob/main/Taskfile.yml),
installing dependencies with `cargo`, `brew`, `npm` & `pip`, and suggests some
VS Code extensions.

Expand Down Expand Up @@ -84,8 +84,8 @@ since it relies on `brew`.
book, or some release artifacts, we'll need some additional tools. But we
won't need those immediately, and the error messages on what's missing should
be clear when we attempt those things. When we hit them, the
[Taskfile.yaml](https://github.com/PRQL/prql/blob/main/Taskfile.yaml) will be
a good source to copy & paste instructions from.
[Taskfile.yaml](https://github.com/PRQL/prql/blob/main/Taskfile.yml) will be a
good source to copy & paste instructions from.

### Option 3: Use a Dev Container

Expand Down

0 comments on commit 7f46a6d

Please sign in to comment.