Skip to content

Telar v0.7.0-beta

Choose a tag to compare

View all tags
@juancobo juancobo released this 31 Jan 05:27
· 603 commits to main since this release
v0.7.0-beta
4fa0d34

Telar v0.7.0-beta

Infrastructure & Code Quality release with test infrastructure, modular code, and accessibility fixes.

Versión en español abajo

Major Features

Test Infrastructure
305 automated tests across three frameworks: Python unit tests (pytest), JavaScript unit tests (Vitest), and end-to-end browser tests (Playwright). Covers CSV processing, IIIF metadata, widgets, story navigation, embed mode, and panel interactions.

Modular Python
The 2,750-line csv_to_json.py has been split into a 14-module telar/ package with clear separation of concerns. Backward-compatible wrapper preserves existing imports.

Modular JavaScript
The 1,872-line story.js has been split into 6 ES modules bundled by esbuild. State management is now centralised, making the code easier to maintain and test.

SCSS Partials
The monolithic 3,374-line stylesheet has been split into 9 maintainable partials.

Enhancements

  • Automated CI testing — Python and JavaScript tests run on every push and pull request
  • Dependabot configuration — Automated dependency updates for GitHub Actions
  • Bilingual upgrade issues — Upgrade issues now match the site's language setting

Fixes

  • WCAG AA accessibility — Improved contrast and added navigation landmarks
  • Intro step z-index — Fixed overlap with navigation buttons when returning to intro
  • Pandas 3.0 compatibility — Updated string dtype handling for newer pandas versions

Migration

If you use GitHub Pages:

  1. Go to your repository's Actions tab
  2. Select "Upgrade Telar" workflow
  3. Click "Run workflow"
  4. Review the upgrade issue and merge the pull request

If you work locally:

python3 scripts/upgrade.py

Migration script: scripts/migrations/v063_to_v070.py

Manual steps required: GitHub Actions workflow files must be copied manually due to security restrictions.

Breaking Changes

Node.js is now required for local builds. Run npm install before building.

Acknowledgments

Telar is developed by Adelaida Ávila, Juan Cobo Betancourt, Santiago Muñoz, and students and scholars at the UCSB Archives, Memory, and Preservation Lab, the UT Archives, Mapping, and Preservation Lab, and Neogranadina.

We gratefully acknowledge the support of the Caribbean Digital Scholarship Collective, the Center for Innovative Teaching, Research, and Learning (CITRAL) at the University of California, Santa Barbara, the UCSB Library, the Routes of Enslavement in the Americas University of California MRPI, and the Department of History of The University of Texas at Austin.

Documentation

Español

Versión de Infraestructura y Calidad de Código con pruebas automatizadas, código modular y mejoras de accesibilidad.

Características Principales

Infraestructura de Pruebas
305 pruebas automatizadas en tres frameworks: pruebas unitarias de Python (pytest), pruebas unitarias de JavaScript (Vitest) y pruebas de navegador de extremo a extremo (Playwright).

Python Modular
El archivo csv_to_json.py de 2,750 líneas se dividió en un paquete telar/ de 14 módulos con separación clara de responsabilidades.

JavaScript Modular
El archivo story.js de 1,872 líneas se dividió en 6 módulos ES empaquetados por esbuild. La gestión de estado ahora está centralizada.

Partials de SCSS
La hoja de estilos monolítica de 3,374 líneas se dividió en 9 partials mantenibles.

Mejoras

  • Pruebas automatizadas en CI — Las pruebas de Python y JavaScript se ejecutan en cada push y pull request
  • Configuración de Dependabot — Actualizaciones automáticas de dependencias
  • Issues de actualización bilingües — Los issues ahora coinciden con el idioma del sitio

Correcciones

  • Accesibilidad WCAG AA — Mejor contraste y landmarks de navegación
  • Z-index del paso de introducción — Corregida superposición con botones de navegación
  • Compatibilidad con Pandas 3.0 — Actualizado manejo de tipos string

Migración

Si usas GitHub Pages:

  1. Ve a la pestaña Actions de tu repositorio
  2. Selecciona el workflow "Upgrade Telar"
  3. Haz clic en "Run workflow"
  4. Revisa el issue de actualización y fusiona el pull request

Si trabajas localmente:

python3 scripts/upgrade.py

Pasos manuales requeridos: Los archivos de workflow de GitHub Actions deben copiarse manualmente.

Cambios Importantes

Node.js ahora es requerido para builds locales. Ejecuta npm install antes de construir.

Agradecimientos

Telar es desarrollado por Adelaida Ávila, Juan Cobo Betancourt, Santiago Muñoz, y estudiantes e investigadores del UCSB Archives, Memory, and Preservation Lab, el UT Archives, Mapping, and Preservation Lab, y Neogranadina.

Agradecemos el apoyo del Caribbean Digital Scholarship Collective, el Center for Innovative Teaching, Research, and Learning (CITRAL) de la University of California, Santa Barbara, la UCSB Library, el Routes of Enslavement in the Americas University of California MRPI, y el Departamento de Historia de la Universidad de Texas en Austin.

Documentación

Release Date: 2026-01-30
Previous Version: v0.6.3-beta

Assets 2
Loading