Skip to content

Commit 9599e01

Browse files
epageepage
committed
chore: Adopt '_rust/main' template
I needed to update pre-commit and decided this would make it easier
2 parents babde1c + 35fcbb7 commit 9599e01

File tree

7 files changed

+135
-67
lines changed

7 files changed

+135
-67
lines changed

‎.github/workflows/ci.yml

+40-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
permissions:
2424
contents: none
2525
name: CI
26-
needs: [test, msrv, lockfile, docs, rustfmt, clippy]
26+
needs: [test, msrv, lockfile, docs, rustfmt, clippy, minimal-versions]
2727
runs-on: ubuntu-latest
2828
if: "always()"
2929
steps:
@@ -34,7 +34,7 @@ jobs:
3434
name: Test
3535
strategy:
3636
matrix:
37-
os: ["ubuntu-latest", "windows-latest", "macos-14"]
37+
os: ["ubuntu-latest", "windows-latest", "macos-latest"]
3838
rust: ["stable"]
3939
continue-on-error: ${{ matrix.rust != 'stable' }}
4040
runs-on: ${{ matrix.os }}
@@ -64,7 +64,25 @@ jobs:
6464
- uses: Swatinem/rust-cache@v2
6565
- uses: taiki-e/install-action@cargo-hack
6666
- name: Default features
67-
run: cargo hack check --feature-powerset --locked --rust-version --ignore-private --workspace --lib --bins
67+
run: cargo hack check --feature-powerset --locked --rust-version --ignore-private --workspace --all-targets
68+
minimal-versions:
69+
name: Minimal versions
70+
runs-on: ubuntu-latest
71+
steps:
72+
- name: Checkout repository
73+
uses: actions/checkout@v4
74+
- name: Install stable Rust
75+
uses: dtolnay/rust-toolchain@stable
76+
with:
77+
toolchain: stable
78+
- name: Install nightly Rust
79+
uses: dtolnay/rust-toolchain@stable
80+
with:
81+
toolchain: nightly
82+
- name: Downgrade dependencies to minimal versions
83+
run: cargo +nightly generate-lockfile -Z minimal-versions
84+
- name: Compile with minimal versions
85+
run: cargo +stable check --workspace --all-features --locked
6886
lockfile:
6987
runs-on: ubuntu-latest
7088
steps:
@@ -138,3 +156,22 @@ jobs:
138156
wait-for-processing: true
139157
- name: Report status
140158
run: cargo clippy --workspace --all-features --all-targets -- -D warnings --allow deprecated
159+
coverage:
160+
name: Coverage
161+
runs-on: ubuntu-latest
162+
steps:
163+
- name: Checkout repository
164+
uses: actions/checkout@v4
165+
- name: Install Rust
166+
uses: dtolnay/rust-toolchain@stable
167+
with:
168+
toolchain: stable
169+
- uses: Swatinem/rust-cache@v2
170+
- name: Install cargo-tarpaulin
171+
run: cargo install cargo-tarpaulin
172+
- name: Gather coverage
173+
run: cargo tarpaulin --output-dir coverage --out lcov
174+
- name: Publish to Coveralls
175+
uses: coverallsapp/github-action@master
176+
with:
177+
github-token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/pre-commit.yml

+2
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,6 @@ jobs:
2424
steps:
2525
- uses: actions/checkout@v4
2626
- uses: actions/setup-python@v5
27+
with:
28+
python-version: '3.x'
2729
- uses: pre-commit/[email protected]

‎.github/workflows/rust-next.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
name: Test
2222
strategy:
2323
matrix:
24-
os: ["ubuntu-latest", "windows-latest", "macos-latest", "macos-14"]
24+
os: ["ubuntu-latest", "windows-latest", "macos-latest"]
2525
rust: ["stable", "beta"]
2626
include:
2727
- os: ubuntu-latest

‎Cargo.toml

+80-53
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,31 @@
1-
[package]
2-
name = "annotate-snippets"
3-
version = "0.11.4"
4-
edition = "2021"
5-
rust-version = "1.65" # MSRV
6-
authors = ["Zibi Braniecki <[email protected]>"]
7-
description = "Library for building code annotations"
8-
license = "Apache-2.0/MIT"
9-
repository = "https://github.com/rust-lang/annotate-snippets-rs"
10-
readme = "README.md"
11-
keywords = ["code", "analysis", "ascii", "errors", "debug"]
1+
[workspace]
2+
resolver = "2"
123

13-
[package.metadata.release]
14-
tag-name = "{{version}}"
15-
pre-release-replacements = [
16-
{file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1},
17-
{file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1},
18-
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1},
19-
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
20-
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/rust-lang/annotate-snippets-rs/compare/{{tag_name}}...HEAD", exactly=1},
4+
[workspace.package]
5+
repository = "https://github.com/rust-lang/annotate-snippets-rs"
6+
license = "MIT OR Apache-2.0"
7+
edition = "2021"
8+
rust-version = "1.65.0" # MSRV
9+
include = [
10+
"build.rs",
11+
"src/**/*",
12+
"Cargo.toml",
13+
"Cargo.lock",
14+
"LICENSE*",
15+
"README.md",
16+
"benches/**/*",
17+
"examples/**/*"
2118
]
2219

23-
[badges]
24-
maintenance = { status = "actively-developed" }
25-
26-
[dependencies]
27-
anstyle = "1.0.4"
28-
memchr = { version = "2.7.4", optional = true }
29-
unicode-width = "0.1.11"
30-
31-
[dev-dependencies]
32-
annotate-snippets = { path = ".", features = ["testing-colors"] }
33-
anstream = "0.6.13"
34-
difference = "2.0.0"
35-
divan = "0.1.14"
36-
glob = "0.3.1"
37-
serde = { version = "1.0.199", features = ["derive"] }
38-
snapbox = { version = "0.6.0", features = ["diff", "term-svg", "cmd", "examples"] }
39-
toml = "0.5.11"
40-
tryfn = "0.2.1"
41-
42-
[[bench]]
43-
name = "bench"
44-
harness = false
45-
46-
[[test]]
47-
name = "fixtures"
48-
harness = false
49-
50-
[features]
51-
default = []
52-
simd = ["memchr"]
53-
testing-colors = []
54-
55-
[lints.rust]
20+
[workspace.lints.rust]
5621
rust_2018_idioms = { level = "warn", priority = -1 }
5722
unreachable_pub = "warn"
5823
unsafe_op_in_unsafe_fn = "warn"
5924
unused_lifetimes = "warn"
6025
unused_macro_rules = "warn"
6126
unused_qualifications = "warn"
6227

63-
[lints.clippy]
28+
[workspace.lints.clippy]
6429
bool_assert_comparison = "allow"
6530
branches_sharing_code = "allow"
6631
checked_conversions = "warn"
@@ -115,6 +80,68 @@ string_lit_as_bytes = "warn"
11580
string_to_string = "warn"
11681
todo = "warn"
11782
trait_duplication_in_bounds = "warn"
83+
uninlined_format_args = "warn"
11884
verbose_file_reads = "warn"
11985
wildcard_imports = "warn"
12086
zero_sized_map_values = "warn"
87+
88+
[package]
89+
name = "annotate-snippets"
90+
version = "0.11.4"
91+
description = "Library for building code annotations"
92+
categories = []
93+
keywords = ["code", "analysis", "ascii", "errors", "debug"]
94+
repository.workspace = true
95+
license.workspace = true
96+
edition.workspace = true
97+
rust-version.workspace = true
98+
include.workspace = true
99+
100+
[package.metadata.docs.rs]
101+
all-features = true
102+
rustdoc-args = ["--cfg", "docsrs"]
103+
104+
[package.metadata.release]
105+
tag-name = "{{version}}"
106+
pre-release-replacements = [
107+
{file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1},
108+
{file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1},
109+
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1},
110+
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
111+
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/rust-lang/annotate-snippets-rs/compare/{{tag_name}}...HEAD", exactly=1},
112+
]
113+
114+
[badges]
115+
maintenance = { status = "actively-developed" }
116+
117+
[dependencies]
118+
anstyle = "1.0.4"
119+
memchr = { version = "2.7.4", optional = true }
120+
unicode-width = "0.1.11"
121+
122+
[dev-dependencies]
123+
annotate-snippets = { path = ".", features = ["testing-colors"] }
124+
anstream = "0.6.13"
125+
difference = "2.0.0"
126+
divan = "0.1.14"
127+
glob = "0.3.1"
128+
serde = { version = "1.0.199", features = ["derive"] }
129+
snapbox = { version = "0.6.0", features = ["diff", "term-svg", "cmd", "examples"] }
130+
toml = "0.5.11"
131+
tryfn = "0.2.1"
132+
133+
[[bench]]
134+
name = "bench"
135+
harness = false
136+
137+
[[test]]
138+
name = "fixtures"
139+
harness = false
140+
141+
[features]
142+
default = []
143+
simd = ["memchr"]
144+
testing-colors = []
145+
146+
[lints]
147+
workspace = true

‎LICENSE-APACHE

+3-2
Original file line numberDiff line numberDiff line change
@@ -178,15 +178,15 @@
178178
APPENDIX: How to apply the Apache License to your work.
179179

180180
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182182
replaced with your own identifying information. (Don't include
183183
the brackets!) The text should be enclosed in the appropriate
184184
comment syntax for the file format. We also recommend that a
185185
file or class name and description of purpose be included on the
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright {yyyy} {name of copyright owner}
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.
@@ -199,3 +199,4 @@
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201201
limitations under the License.
202+

‎LICENSE-MIT

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Copyright 2017 Mozilla
1+
Copyright (c) Individual contributors
22

3-
Permission is hereby granted, free of charge, to any person obtaining a copy of
4-
this software and associated documentation files (the "Software"), to deal in
5-
the Software without restriction, including without limitation the rights to
6-
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7-
of the Software, and to permit persons to whom the Software is furnished to do
8-
so, subject to the following conditions:
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
99

1010
The above copyright notice and this permission notice shall be included in all
1111
copies or substantial portions of the Software.

‎release.toml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
allow-branch = ["master"]
1+
dependent-version = "fix"
2+
allow-branch = ["main"]

0 commit comments

Comments
 (0)