Skip to content

Commit 77fded8

Browse files
committed
Add real version
1 parent cda8758 commit 77fded8

15 files changed

Lines changed: 322 additions & 1 deletion

‎.github/dependabot.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "julia"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "weekly"

‎.github/workflows/juliaci.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Julia CI
2+
3+
on:
4+
push: {branches: [main, master]}
5+
pull_request: {types: [opened, synchronize, reopened, ready_for_review, converted_to_draft]}
6+
issue_comment: {types: [created]}
7+
workflow_dispatch:
8+
inputs:
9+
feature:
10+
type: choice
11+
description: What to run
12+
options: [DocDeploy, LintAndTest, TagBot]
13+
14+
jobs:
15+
julia-ci:
16+
uses: julia-testitems/testitem-workflow/.github/workflows/juliaci.yml@v2
17+
permissions: write-all
18+
secrets:
19+
codecov_token: ${{ secrets.CODECOV_TOKEN }}

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Manifest.toml
2+
Manifest-v*.toml
3+
docs/build/
4+
*.jl.cov
5+
*.jl.*.cov
6+
*.jl.mem
7+
lcov.info

‎JuliaFormat.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
style = "runic"

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 David Anthoff
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Project.toml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,13 @@ name = "TestItemExamplePackage"
22
uuid = "d5163d8a-30d8-45f6-a98f-5aa01283b29f"
33
version = "0.1.0"
44
authors = ["David Anthoff <anthoff@berkeley.edu>"]
5+
6+
[compat]
7+
julia = "1.10"
8+
9+
[extras]
10+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
11+
TestItemRunner = "f8b46487-2199-4994-9208-9a1283c18c0a"
12+
13+
[targets]
14+
test = ["Test", "TestItemRunner"]

‎README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# TestItemExamplePackage.jl
2+
3+
[![CI](https://github.com/julia-testitems/TestItemExamplePackage.jl/actions/workflows/juliaci.yml/badge.svg?branch=main)](https://github.com/julia-testitems/TestItemExamplePackage.jl/actions/workflows/juliaci.yml)
4+
[![codecov](https://codecov.io/gh/julia-testitems/TestItemExamplePackage.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/julia-testitems/TestItemExamplePackage.jl)
5+
[![Docs (dev)](https://img.shields.io/badge/docs-dev-blue.svg)](https://julia-testitems.github.io/TestItemExamplePackage.jl/dev)
6+
7+
A tiny temperature-conversion package that exists to demonstrate a Julia package
8+
fully on the [test item](https://julia-testitems.org) stack: `@testitem` tests in
9+
`test/`, `Pkg.test` compatibility via TestItemRunner.jl, CI through the reusable
10+
[testitem-workflow](https://github.com/julia-testitems/testitem-workflow), an
11+
active format check (`JuliaFormat.toml`), and Documenter docs deployed by the same
12+
workflow.
13+
14+
The step-by-step story of what was added to the bare package is told in the
15+
[Example chapter](https://julia-testitems.org/guide/example) of the test item docs.
16+
17+
## Try it
18+
19+
```sh
20+
juliati # run all test items (needs TestItemApp.jl)
21+
juliaformat --check . # the CI format gate, locally
22+
julia --project -e 'using Pkg; Pkg.test()' # the classic way still works
23+
```

‎docs/Project.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
TestItemExamplePackage = "d5163d8a-30d8-45f6-a98f-5aa01283b29f"
4+
5+
[sources]
6+
TestItemExamplePackage = {path = ".."}
7+
8+
[compat]
9+
Documenter = "1"

‎docs/make.jl‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
using Documenter, TestItemExamplePackage
2+
3+
makedocs(
4+
sitename = "TestItemExamplePackage.jl",
5+
modules = [TestItemExamplePackage],
6+
pages = [
7+
"Home" => "index.md",
8+
"API" => "api.md",
9+
],
10+
)
11+
12+
deploydocs(
13+
repo = "github.com/julia-testitems/TestItemExamplePackage.jl.git",
14+
push_preview = true,
15+
)

‎docs/src/api.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API
2+
3+
```@autodocs
4+
Modules = [TestItemExamplePackage]
5+
```

0 commit comments

Comments
 (0)