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

Fix docs pipeline, make docs tests easier to run locally and on different OSes #1554

Merged
merged 15 commits into from Aug 21, 2022

Conversation

wren
Copy link
Member

@wren wren commented Aug 15, 2022

While making PR #1553, I noticed that the docs pipeline is failing. So, this PR:

  • Fixes the docs pipeline
  • Removes dependency on yq package (since it uses jq, which might not be installed)
  • Uses xmltodict to read sitemap
  • Makes task runner poe work better on other systems (like Windows) by creating OS-agnostic tasks (in the newly created tasks.py file in the root)
  • Removes dependency on curl which isn't reliably installed on contributors' machines
  • Updates linting/testing to go over new tasks.py file to reduce future errors in tasks
  • Update docs pipeline to use poe tasks
  • Adds package.json and package.lock files since we already use npm to test the docs site, anyway. This stops us from hardcoding the dependencies into the CI pipeline, and makes it easier to get everything you need locally for testing the docs site (just run npm install).
  • Having our dependencies in a proper package.json file will also allow Dependabot to test and notify us of updates/issues

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • 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.

@micahellison micahellison added the build Issues related to the build pipeline label Aug 21, 2022
@micahellison micahellison merged commit 671f403 into jrnl-org:develop Aug 21, 2022
@micahellison micahellison deleted the docs-pipeline-fix branch August 21, 2022 20:47
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.

None yet

2 participants