Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 3.1.0 #226

Merged
merged 8 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
type: boolean

jobs:
build:
publish:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
Expand Down
24 changes: 23 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,29 @@

## 3.1.0 (2023-11-14)

* Placeholder
### Changes

* Upgrade `pa11y` to `^6.2.3` from `~6.1.0`
* Switch to caret for `pa11y` to allow `pa11y` to be upgraded to a more recent compatible version upon install (thanks @aarongoldenthal)
* [Fix licensing identifier](https://github.com/pa11y/pa11y-ci/pull/123) (thanks @LorenzoAncora)
* Update documentation:
* Indicate support for more recent stable versions of operating systems and Node.js
* Add [JS config file example](https://github.com/pa11y/pa11y-ci/pull/197) (thanks @aarongoldenthal)

### New contributors

* @LorenzoAncora [made their first contribution](https://github.com/pa11y/pa11y-ci/pull/123)
* @danyalaytekin [made their first contribution](https://github.com/pa11y/pa11y-ci/pull/213)

### Behind the scenes

* Expand testing to:
* [test Windows and macOS](https://github.com/pa11y/pa11y-ci/pull/177) alongside Linux (thanks again @aarongoldenthal)
* test with Node.js 18 and 20, alongside 12, 14, 16

### Full changelog

[3.0.1...3.1.0](https://github.com/pa11y/pa11y-ci/compare/3.0.1...3.1.0)

## 3.0.1 (2021-12-20)

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ npm install -g pa11y-ci
```

```console
$ npx pa11y-ci --help
$ pa11y-ci --help

Usage: pa11y-ci [options] <paths>

Expand Down Expand Up @@ -138,7 +138,7 @@ pa11y-ci --sitemap https://pa11y.org/sitemap.xml

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

> NOTE
> [!NOTE]
> Providing a sitemap will cause the `urls` property in your JSON config to be ignored.

#### Transforming URLs retrieved from a sitemap before testing
Expand Down Expand Up @@ -199,7 +199,7 @@ You can use multiple reporters by setting them on the `defaults.reporters` array
}
```

> NOTE
> [!NOTE]
> If the `--reporter` flag is provided on the command line, all appearances of `reporters` in the config file will be overridden.

### Reporter options
Expand Down Expand Up @@ -434,6 +434,6 @@ Copyright &copy; 2016-2023, Team Pa11y and contributors
[info-build]: https://github.com/pa11y/pa11y-ci/actions/workflows/tests.yml

[shield-license]: https://img.shields.io/badge/license-LGPL--3.0--only-blue.svg
[shield-node]: https://img.shields.io/badge/node.js%20support-8-brightgreen.svg
[shield-node]: https://img.shields.io/node/v/pa11y-ci.svg
[shield-npm]: https://img.shields.io/npm/v/pa11y-ci.svg
[shield-build]: https://github.com/pa11y/pa11y-ci/actions/workflows/tests.yml/badge.svg
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pa11y-ci",
"version": "3.0.1",
"version": "3.1.0",
"description": "Pa11y CI is a CI-centric accessibility test runner, built using Pa11y",
"keywords": [],
"author": "Team Pa11y",
Expand Down
Loading