|
2 | 2 |
|
3 | 3 | ## ORCID Validation Improvements |
4 | 4 |
|
5 | | -* **Graceful authentication handling**: ORCID validation functions now handle authentication failures gracefully instead of requiring interactive login |
6 | | -* **New `skip_on_auth_error` parameter**: Added to `validate_codecheck_yml_orcid()` and `validate_contents_references()` to control behavior when ORCID authentication is unavailable (defaults to `TRUE` for non-interactive environments) |
7 | | -* **Enhanced error messages**: Clear guidance provided when ORCID authentication is needed, with instructions for setting `ORCID_TOKEN` environment variable |
8 | | -* **Test and CI/CD compatibility**: Certificate template and all validation functions now work seamlessly in test and CI/CD environments without requiring ORCID authentication |
9 | | -* **Backward compatibility**: Existing code continues to work without modification; validation automatically skips when authentication is unavailable |
| 5 | +* **Graceful authentication handling**: ORCID validation functions now handle authentication failures gracefully with clear error messages instead of requiring interactive login |
| 6 | +* **New `skip_on_auth_error` parameter**: Added to `validate_codecheck_yml_orcid()` and `validate_contents_references()` to control behavior when ORCID authentication is unavailable. By default (`FALSE`), functions require authentication. Set to `TRUE` to skip validation when authentication is not available (useful for CI/CD pipelines and test environments). |
| 7 | +* **Enhanced error messages**: Clear guidance provided when ORCID authentication is needed, with instructions for setting `ORCID_TOKEN` environment variable or running `rorcid::orcid_auth()` |
| 8 | +* **Opt-in skipping**: Certificate authors can choose to skip ORCID validation by setting `skip_on_auth_error = TRUE` in the certificate template |
10 | 9 | * **Better feedback**: Functions now return a `skipped` field indicating whether validation was skipped due to authentication issues |
11 | 10 |
|
12 | 11 | ## Manifest Rendering Enhancements |
13 | 12 |
|
14 | 13 | * **Expanded format support**: Certificates can now render additional file formats in the manifest section: |
15 | | - - Image formats: TIF, TIFF, EPS, and SVG (with automatic PDF conversion) |
| 14 | + - Image formats: TIF, TIFF, GIF, EPS, and SVG (with automatic conversion) |
16 | 15 | - Data formats: JSON (with pretty-printing and configurable line limits) and TSV (tab-separated values) |
17 | 16 | - Multi-page PDFs are now fully supported with automatic page detection |
| 17 | +* **GIF format support**: GIF images are now automatically converted to PNG during certificate rendering. pdflatex does not natively support GIF format, so conversion is required. |
| 18 | +* **TIF/TIFF format support**: TIF and TIFF images are now automatically converted to PNG during certificate rendering. |
| 19 | +* **New dependency**: Added `magick` package as a required dependency for image format conversion (TIF/TIFF/GIF to PNG). Previously this was optional, but is now mandatory for proper image format support. |
| 20 | +* **Graceful error handling**: Missing, corrupted, or unsupported files no longer fail the entire certificate rendering. Instead, a formatted error box is displayed in the PDF for each problematic file, allowing codecheckers to identify and fix issues without blocking certificate generation. |
| 21 | +* **File existence checks**: All manifest rendering functions now check for file existence before processing and display helpful error messages. |
| 22 | +* **Improved error messages**: Error messages are now displayed as formatted LaTeX boxes in the rendered PDF with specific information about what went wrong (e.g., "File not found", "Failed to convert GIF image", "Unsupported file format (.xyz)"). |
18 | 23 | * **Improved maintainability**: Manifest rendering code refactored into modular, testable components |
19 | | -* **Comprehensive testing**: Added extensive test suite covering all supported formats with manual inspection output |
| 24 | +* **Comprehensive testing**: Added extensive test suite covering all supported formats including GIF with test fixtures |
20 | 25 |
|
21 | 26 | # codecheck 0.22.0 |
22 | 27 |
|
|
0 commit comments