Docs | Getting Started | Github
xc
is a task runner designed to maximise convenience, and minimise complexity.
Each xc
task is defined in simple, human-readable Markdown. Meaning that for people without the xc
tool installed there is a clear source of useful commands in the README.md file.
Installation instructions are defined at https://xcfile.dev/getting-started/#installation.
- Markdown defined tasks.
- Editor tools:
- VSCode (list and run xc tasks)
- Vim (recommended config for listing and running xc tasks)
Take the tag
task in the README.md of the xc
repository:
## tag
Deploys a new tag for the repo.
Requires: test
```
export VERSION=`git rev-list --count HEAD`
echo Adding git tag with version v0.0.${VERSION}
git tag v0.0.${VERSION}
git push origin v0.0.${VERSION}
```
The task could be run simply with xc tag
, but a side-effect of it being an xc
task is that the steps for pushing a tag without the use of xc
are clearly documented too.
$ xc tag
go test ./...
? github.com/joerdav/xc/cmd/xc [no test files]
? github.com/joerdav/xc/models [no test files]
ok github.com/joerdav/xc/parser (cached)
ok github.com/joerdav/xc/run (cached)
export VERSION=78
echo Adding git tag with version v0.0.78
Adding git tag with version v0.0.78
git tag v0.0.78
git push origin v0.0.78
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
To github.com:joerdav/xc
* [new tag] v0.0.78 -> v0.0.78
Test the project.
go test ./...
Builds the xc
binary.
go build ./cmd/xc
Deploys a new tag for the repo.
Requires: test
export VERSION=`git rev-list --count HEAD`
echo Adding git tag with version v0.0.${VERSION}
git tag v0.0.${VERSION}
git push origin v0.0.${VERSION}
Updates nix flake.
sh ./update-nix.sh