2021-04-29 16:14:50 +02:00
|
|
|
# Changelog
|
|
|
|
|
|
2021-05-29 21:38:36 +02:00
|
|
|
All notable changes to this project will be documented in this file. The format
|
|
|
|
|
is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
2021-04-29 16:14:50 +02:00
|
|
|
|
2021-05-29 21:38:36 +02:00
|
|
|
This project has its own custom versioning scheme. Version numbers consist of
|
|
|
|
|
three parts (e. g. `3.1.5`).
|
|
|
|
|
- The first number is increased on major rewrites or changes. What classifies as
|
|
|
|
|
a major change is up to the maintainers. This is pretty rare and a PFERD
|
|
|
|
|
version 4 should hopefully not be necessary.
|
|
|
|
|
- The second number is increased on backwards-incompatible changes in behaviour.
|
|
|
|
|
This refers to any change that would make an existing setup behave differently
|
|
|
|
|
(e. g. renaming options or changing crawler behaviour). If this number is
|
|
|
|
|
increased, it may be necessary for you to adapt your own setup.
|
|
|
|
|
- The third number is increased on backwards-compatible changes (e. g. adding
|
|
|
|
|
new options or commands, changing documentation, fixing bugs). Updates that
|
|
|
|
|
only increase this number should be safe and not require manual intervention.
|
|
|
|
|
|
|
|
|
|
We will try to correctly classify changes as backwards-compatible or
|
|
|
|
|
backwards-incompatible, but may occasionally make mistakes or stumble across
|
|
|
|
|
ambiguous situations.
|
2021-04-29 16:14:50 +02:00
|
|
|
|
2021-05-24 20:08:49 +02:00
|
|
|
## Unreleased
|
2021-04-29 16:14:50 +02:00
|
|
|
|
2021-05-31 12:49:04 +02:00
|
|
|
## 3.0.0 - 2021-05-31
|
|
|
|
|
|
2021-04-29 16:14:50 +02:00
|
|
|
### Added
|
2021-05-25 17:16:57 +02:00
|
|
|
- Proper config files
|
|
|
|
|
- Concurrent crawling
|
|
|
|
|
- Crawl external ILIAS links
|
|
|
|
|
- Crawl uploaded exercise solutions
|
|
|
|
|
- Explain what PFERD is doing and why (`--explain`)
|
|
|
|
|
- More control over output (`--status`, `--report`)
|
2021-05-26 11:47:51 +02:00
|
|
|
- Debug transform rules with `--debug-transforms`
|
2021-05-25 17:16:57 +02:00
|
|
|
- Print report after exiting via Ctrl+C
|
|
|
|
|
- Store crawler reports in `.report` JSON file
|
|
|
|
|
- Extensive config file documentation (`CONFIG.md`)
|
|
|
|
|
- Documentation for developers (`DEV.md`)
|
2021-04-29 16:14:50 +02:00
|
|
|
- This changelog
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Rewrote almost everything
|
2021-05-25 17:16:57 +02:00
|
|
|
- Better error messages
|
2021-04-29 16:14:50 +02:00
|
|
|
- Redesigned CLI
|
2021-05-25 17:16:57 +02:00
|
|
|
- Redesigned transform rules
|
|
|
|
|
- ILIAS crawling logic (paths may be different)
|
|
|
|
|
- Better support for weird paths on Windows
|
|
|
|
|
- Set user agent (`PFERD/<version>`)
|
2021-04-29 16:14:50 +02:00
|
|
|
|
|
|
|
|
### Removed
|
|
|
|
|
- Backwards compatibility with 2.x
|
2021-05-25 17:16:57 +02:00
|
|
|
- Python files as config files
|
|
|
|
|
- Some types of crawlers
|
