Skip to content

Commit 8113c6c

Browse files
mtfishmanclaude
mtfishman
and
claude
authored
Update to skeleton template (#15)
Applies the current ITensorPkgSkeleton template to ITensorUnicodePlots.jl, bringing it structurally in line with the rest of the ecosystem so it can be included in ITensor/ITensorOrgPatches and receive ecosystem-wide patches automatically. No user-facing API changes (patch bump 0.1.6 → 0.1.7). Per-file notes: - Replaces legacy CI.yml + Register.yml with split skeleton workflows delegating to ITensor/ITensorActions (Tests, Documentation, FormatCheck, FormatPullRequest, IntegrationTest, IntegrationTestRequest, Registrator, VersionCheck). TagBot, CompatHelper, dependabot synced to skeleton. - Adds .pre-commit-config.yaml, benchmark/, docs/src/assets/, docs/src/reference.md, examples/README.jl, test/test_aqua.jl, .github/ISSUE_TEMPLATE/, PULL_REQUEST_TEMPLATE.md. - Root Project.toml switches from [extras]/[targets] test pattern to a [workspace] projects list. Subdir Project.tomls get [sources.ITensorUnicodePlots] and their own [compat] entries, dropping the stale ITensorMPS = "0.2.2" / ITensors = "0.6.8" pins in test/Project.toml. - test/runtests.jl → ITensorPkgSkeleton.runtests(; testdir), which auto-discovers test_*.jl and walks examples/. test_examples.jl is deleted — the walk in runtests handles what it used to do. - test_aqua.jl passes cleanly without any kwarg overrides (no piracy or ambiguity issues). - references_v1.12/ added for the new test_basics reference format (the package already tracks references_v1.10 and references_v1.11). - itpkgfmt --yaml pass across the tree accounts for most of the diff volume (src/, test/, examples/, workflow YAML). Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent b13d258 commit 8113c6c

51 files changed

Lines changed: 885 additions & 396 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: ITensorUnicodePlots.jl bug report
3+
about: Create a bug report to help us improve ITensorUnicodePlots.jl
4+
title: "[BUG] YOUR SHORT DESCRIPTION OF THE BUG HERE"
5+
labels: ["bug"]
6+
assignees: ''
7+
8+
---
9+
10+
**Description of bug**
11+
12+
Please give a brief description of the bug or unexpected behavior here.
13+
14+
**Minimal code demonstrating the bug or unexpected behavior**
15+
16+
If applicable, provide a minimal code that can be run to demonstrate the bug or unexpected behavior.
17+
18+
If you are unable to construct a minimal code that demonstrates the bug or unexpected behavior, provide detailed steps for how to reproduce the behavior you are seeing.
19+
20+
<details><summary>Minimal runnable code</summary><p>
21+
22+
```julia
23+
[YOUR MINIMAL RUNNABLE CODE HERE]
24+
```
25+
26+
</p></details>
27+
28+
29+
**Expected output or behavior**
30+
31+
Describe what you expected to happen.
32+
33+
If you provided a minimal code that can be run to demonstrate the bug or unexpected behavior, describe what you expected the output would be.
34+
35+
36+
**Actual output or behavior**
37+
38+
Describe what actually happened.
39+
40+
If you provided a minimal code that demonstrates the bug or unexpected behavior, provide the output you get from that code. If the code leads to an error or warning, include the full error or warning below.
41+
42+
<details><summary>Output of minimal runnable code</summary><p>
43+
44+
```julia
45+
[OUTPUT OF YOUR MINIMAL RUNNABLE CODE HERE]
46+
```
47+
48+
</p></details>
49+
50+
51+
**Version information**
52+
53+
- Output from `versioninfo()`:
54+
```julia
55+
julia> versioninfo()
56+
[YOUR OUTPUT HERE]
57+
```
58+
- Output from `using Pkg; Pkg.status("ITensorUnicodePlots")`:
59+
```julia
60+
julia> using Pkg; Pkg.status("ITensorUnicodePlots")
61+
[YOUR OUTPUT HERE]
62+
```

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: ITensorUnicodePlots.jl feature request
3+
about: Suggest an idea for ITensorUnicodePlots.jl
4+
title: "[ENHANCEMENT] YOUR SHORT DESCRIPTION OF THE FEATURE REQUEST HERE"
5+
labels: ["enhancement"]
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
**Describe the solution you'd like**
15+
16+
A clear and concise description of what you want to happen.
17+
18+
**Describe alternatives you've considered**
19+
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
**Additional context**
23+
24+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed (if applicable). Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes #(issue)
6+
7+
If practical and applicable, please include a minimal demonstration of the previous behavior and new behavior below.
8+
9+
<details><summary>Minimal demonstration of previous behavior</summary><p>
10+
11+
```julia
12+
[YOUR MINIMAL DEMONSTRATION OF PREVIOUS BEHAVIOR]
13+
```
14+
15+
</p></details>
16+
17+
<details><summary>Minimal demonstration of new behavior</summary><p>
18+
19+
```julia
20+
[YOUR MINIMAL DEMONSTRATION OF NEW BEHAVIOR]
21+
```
22+
23+
</p></details>
24+
25+
# How Has This Been Tested?
26+
27+
Please add tests that verify your changes to a file in the `test` directory.
28+
29+
Please give a summary of the tests that you added to verify your changes.
30+
31+
- [ ] Test A
32+
- [ ] Test B
33+
34+
# Checklist:
35+
36+
- [ ] My code follows the style guidelines of this project. Please run the [ITensorFormatter](https://github.com/ITensor/ITensorFormatter.jl) in the base directory of the repository (`~/.julia/dev/ITensorUnicodePlots`) to format your code according to our style guidelines.
37+
- [ ] I have performed a self-review of my own code.
38+
- [ ] I have commented my code, particularly in hard-to-understand areas.
39+
- [ ] I have added tests that verify the behavior of the changes I made.
40+
- [ ] I have made corresponding changes to the documentation.
41+
- [ ] My changes generate no new warnings.
42+
- [ ] Any dependent changes have been merged and published in downstream modules.

‎.github/dependabot.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
21
version: 2
32
updates:
43
- package-ecosystem: "github-actions"
5-
directory: "/" # Location of package manifests
4+
directory: "/"
65
schedule:
76
interval: "weekly"

‎.github/workflows/CI.yml‎

Lines changed: 0 additions & 76 deletions
This file was deleted.

‎.github/workflows/CompatHelper.yml‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
name: CompatHelper
1+
name: "CompatHelper"
22
on:
33
schedule:
4-
- cron: 0 0 * * *
5-
workflow_dispatch:
4+
- cron: "0 0 * * *"
5+
workflow_dispatch: ~
6+
permissions:
7+
contents: "write"
8+
pull-requests: "write"
69
jobs:
7-
CompatHelper:
8-
runs-on: ubuntu-latest
9-
steps:
10-
- name: Pkg.add("CompatHelper")
11-
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
12-
- name: CompatHelper.main()
13-
env:
14-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15-
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
16-
run: julia -e 'using CompatHelper; CompatHelper.main()'
10+
compat-helper:
11+
name: "CompatHelper"
12+
uses: "ITensor/ITensorActions/.github/workflows/CompatHelper.yml@main"
13+
with:
14+
localregistry: "https://github.com/ITensor/ITensorRegistry.git"

‎.github/workflows/Documentation.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "Documentation"
2+
on:
3+
push:
4+
branches:
5+
- "main"
6+
tags: "*"
7+
pull_request: ~
8+
schedule:
9+
- cron: "1 4 * * 4"
10+
concurrency:
11+
group: "${{ github.workflow }}-${{ github.ref }}"
12+
cancel-in-progress: "${{ github.ref_name != github.event.repository.default_branch || github.ref != 'refs/tags/v*' }}"
13+
jobs:
14+
build-and-deploy-docs:
15+
name: "Documentation"
16+
uses: "ITensor/ITensorActions/.github/workflows/Documentation.yml@main"
17+
with:
18+
localregistry: "https://github.com/ITensor/ITensorRegistry.git"
19+
secrets:
20+
CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"

‎.github/workflows/FormatCheck.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: "Format Check"
2+
on:
3+
pull_request_target:
4+
types:
5+
- "opened"
6+
- "synchronize"
7+
- "reopened"
8+
- "ready_for_review"
9+
permissions:
10+
contents: "read"
11+
actions: "write"
12+
pull-requests: "write"
13+
jobs:
14+
format-check:
15+
name: "Format Check"
16+
uses: "ITensor/ITensorActions/.github/workflows/FormatCheck.yml@main"

‎.github/workflows/FormatPullRequest.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: "Format Pull Request"
2+
on:
3+
schedule:
4+
- cron: "0 0 * * *"
5+
workflow_dispatch: ~
6+
issue_comment:
7+
types:
8+
- "created"
9+
permissions:
10+
contents: "write"
11+
pull-requests: "write"
12+
jobs:
13+
format-pull-request:
14+
name: "Format Pull Request"
15+
uses: "ITensor/ITensorActions/.github/workflows/FormatPullRequest.yml@main"
16+
secrets: "inherit"

‎.github/workflows/IntegrationTest.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: "IntegrationTest"
2+
on:
3+
push:
4+
branches:
5+
- "main"
6+
tags: "*"
7+
pull_request_target:
8+
types:
9+
- "opened"
10+
- "synchronize"
11+
- "reopened"
12+
- "ready_for_review"
13+
- "converted_to_draft"
14+
jobs:
15+
integration-test:
16+
name: "IntegrationTest"
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
pkg:
21+
- "__none__"
22+
uses: "ITensor/ITensorActions/.github/workflows/IntegrationTest.yml@main"
23+
secrets: "inherit"
24+
with:
25+
localregistry: "https://github.com/ITensor/ITensorRegistry.git"
26+
pkg: "${{ matrix.pkg }}"
27+
integration-gate:
28+
name: "IntegrationTest"
29+
needs: "integration-test"
30+
if: "${{ always() && needs.integration-test.result != 'skipped' }}"
31+
runs-on: "ubuntu-latest"
32+
steps:
33+
- name: "Fail if any downstream integration test failed"
34+
run: |
35+
echo "integration-test.result = ${{ needs.integration-test.result }}"
36+
test "${{ needs.integration-test.result }}" = "success"
37+

0 commit comments

Comments
 (0)