Skip to content
This repository has been archived by the owner on Mar 31, 2022. It is now read-only.

Verify the configuration of each course before deploy #12

Open
3 tasks
anandology opened this issue Oct 22, 2021 · 2 comments
Open
3 tasks

Verify the configuration of each course before deploy #12

anandology opened this issue Oct 22, 2021 · 2 comments
Labels
build help wanted Extra attention is needed

Comments

@anandology
Copy link
Contributor

Every course has a course.yml file and markdown file for each lesson has yaml frontmatter. If there is any error in these files, the deploy fails. We want to verify this on every PR and fail.

Interface

The verification process will be triggered by running the lint command. It should test for each possible error, report all errors and fail with non-zero exit code if any issue is found.

$ python manage.py lint

Tasks

  • implement lint command
  • verify the correctness of course.yml file in each course
  • verify the frontmatter of each lesson is valid
@anandology anandology added help wanted Extra attention is needed build labels Oct 22, 2021
@anandology
Copy link
Contributor Author

It may be a good idea to this using pytest. There could be a test_website directory with all the tests.

@anandology
Copy link
Contributor Author

Tried writing test cases. It feels like having a linter a good idea and it'll allow us to test the linter as well.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
build help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant