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

Change approach for docs workflow to use pa11y-ci #1116

Merged
merged 1 commit into from
Dec 19, 2020

Conversation

wren
Copy link
Member

@wren wren commented Dec 14, 2020

The previous plugin looked nice with the comments and annotations, but apparently doesn't work for PRs. It can only run on the pr target (our branch), which means that the tests are never actually run against the new code.

As you can guess, this is pretty useless for PRs. So, this PR fixes that, and uses the very nice pa11y-ci (instead of the normal pa11y). While it doesn't upload annotations, the output is very readable and seems like the best we're going to get.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have tested this code locally.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.
  • All tests pass.

Note: The failing tests docs test will be fixed in a separate PR. This is just to get the CI working to where that PR will get real test results.

The previous plugin looked nice with the comments and annotations, but
apparently doesn't work for PRs. It can only run on the pr target (our
branch), which means that the tests are never actually run against the
new code.

As you can guess, this is pretty useless for PRs. So, this PR fixes
that, and uses the very nice pa11y-ci (instead of the normal pa11y).
While it doesn't upload annotations, the output is very readable and
seems like the best we're going to get.
@wren
Copy link
Member Author

wren commented Dec 14, 2020

See #1113 for how the above issue affects PRs.

@github-actions
Copy link

Unit Test Results

  9 files  9 suites   0s ⏱️
49 tests 0 ✔️ 0 💤 49 ❌

results for commit b1bc4e0

Copy link
Member

@micahellison micahellison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📃

@micahellison micahellison added documentation Improvements or additions to documentation build Issues related to the build pipeline and removed documentation Improvements or additions to documentation labels Dec 19, 2020
@micahellison micahellison merged commit 12e39ff into jrnl-org:develop Dec 19, 2020
@wren wren deleted the docs-workflow-fix branch December 28, 2020 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues related to the build pipeline
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants