Skip to content

Commit 76b1dc1

Browse files
Version 3.1.0 (#226)
* Change id of publishing job to `publish` from `build` * Set version to `3.1.0` from `3.0.1` * Add changelog entry for `3.1.0` * Shorten link to full changelog * Remove errant `npx` * Fix syntax for notes * Add #197 to changelog * Fix Node version’s badge
1 parent 4ab436d commit 76b1dc1

File tree

5 files changed

+31
-9
lines changed

5 files changed

+31
-9
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010
type: boolean
1111

1212
jobs:
13-
build:
13+
publish:
1414
runs-on: ubuntu-20.04
1515
steps:
1616
- uses: actions/checkout@v4

CHANGELOG.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,29 @@
22

33
## 3.1.0 (2023-11-14)
44

5-
* Placeholder
5+
### Changes
6+
7+
* Upgrade `pa11y` to `^6.2.3` from `~6.1.0`
8+
* Switch to caret for `pa11y` to allow `pa11y` to be upgraded to a more recent compatible version upon install (thanks @aarongoldenthal)
9+
* [Fix licensing identifier](https://github.com/pa11y/pa11y-ci/pull/123) (thanks @LorenzoAncora)
10+
* Update documentation:
11+
* Indicate support for more recent stable versions of operating systems and Node.js
12+
* Add [JS config file example](https://github.com/pa11y/pa11y-ci/pull/197) (thanks @aarongoldenthal)
13+
14+
### New contributors
15+
16+
* @LorenzoAncora [made their first contribution](https://github.com/pa11y/pa11y-ci/pull/123)
17+
* @danyalaytekin [made their first contribution](https://github.com/pa11y/pa11y-ci/pull/213)
18+
19+
### Behind the scenes
20+
21+
* Expand testing to:
22+
* [test Windows and macOS](https://github.com/pa11y/pa11y-ci/pull/177) alongside Linux (thanks again @aarongoldenthal)
23+
* test with Node.js 18 and 20, alongside 12, 14, 16
24+
25+
### Full changelog
26+
27+
[3.0.1...3.1.0](https://github.com/pa11y/pa11y-ci/compare/3.0.1...3.1.0)
628

729
## 3.0.1 (2021-12-20)
830

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ npm install -g pa11y-ci
2626
```
2727

2828
```console
29-
$ npx pa11y-ci --help
29+
$ pa11y-ci --help
3030

3131
Usage: pa11y-ci [options] <paths>
3232

@@ -138,7 +138,7 @@ pa11y-ci --sitemap https://pa11y.org/sitemap.xml
138138

139139
Pa11y will be run against the text content of each `<loc/>` in the sitemap's XML.
140140

141-
> NOTE
141+
> [!NOTE]
142142
> Providing a sitemap will cause the `urls` property in your JSON config to be ignored.
143143
144144
#### Transforming URLs retrieved from a sitemap before testing
@@ -199,7 +199,7 @@ You can use multiple reporters by setting them on the `defaults.reporters` array
199199
}
200200
```
201201

202-
> NOTE
202+
> [!NOTE]
203203
> If the `--reporter` flag is provided on the command line, all appearances of `reporters` in the config file will be overridden.
204204
205205
### Reporter options
@@ -434,6 +434,6 @@ Copyright &copy; 2016-2023, Team Pa11y and contributors
434434
[info-build]: https://github.com/pa11y/pa11y-ci/actions/workflows/tests.yml
435435

436436
[shield-license]: https://img.shields.io/badge/license-LGPL--3.0--only-blue.svg
437-
[shield-node]: https://img.shields.io/badge/node.js%20support-8-brightgreen.svg
437+
[shield-node]: https://img.shields.io/node/v/pa11y-ci.svg
438438
[shield-npm]: https://img.shields.io/npm/v/pa11y-ci.svg
439439
[shield-build]: https://github.com/pa11y/pa11y-ci/actions/workflows/tests.yml/badge.svg

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "pa11y-ci",
3-
"version": "3.0.1",
3+
"version": "3.1.0",
44
"description": "Pa11y CI is a CI-centric accessibility test runner, built using Pa11y",
55
"keywords": [],
66
"author": "Team Pa11y",

0 commit comments

Comments
 (0)