Skip to content

CHANGELOG.md

Latest commit

 

History

History
329 lines (180 loc) · 15.3 KB

CHANGELOG.md

File metadata and controls

329 lines (180 loc) · 15.3 KB

Changelog

All changes that impact users of this module are documented in this file, in the Common Changelog format with some additional specifications defined in the CONTRIBUTING file. This codebase adheres to Semantic Versioning.

3.1.0 - 2026-02-05

Full changeset and discussions: #64.

Development of this release was supported by Reset Tech.

Changed

  • Make nginx role usable outside this collection

3.0.1 - 2026-02-05

Full changeset and discussions: #63.

Development of this release was supported by Reset Tech.

Added

  • Add migrate playbook for one-time changes on existing servers; run ansible-playbook opentermsarchive.deployment.migrate before deploy when upgrading

Fixed

  • Replace NodeSource repository with native Node.js packages on Debian >= 13 to fix deployment failure caused by NodeSource GPG key using SHA-1, rejected by apt since 2026-02-01

3.0.0 - 2025-12-19

Full changeset and discussions: #58.

Development of this release was supported by Reset Tech.

Added

  • Support multi-tenant deployment on a single server, with isolated PM2 instances, nginx configurations, and SSH keys per collection
  • Add configurable rate limiting for API requests through ota_rate_limit_rate and ota_rate_limit_burst inventory variables

Changed

  • Breaking: Rename ota_source_repository to ota_collection_repository
  • Breaking: Rename ota_source_repository_branch to ota_collection_repository_branch
  • Scope PM2 home directory per collection (~/.pm2-{collection_id})
  • Scope GitHub bot SSH keys per collection (~/.ssh/ota-github-bot-key-{collection_id})
  • Scope nginx configuration files per collection

2.1.1 - 2025-11-28

Full changeset and discussions: #57.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Fixed

  • Ensure compatibility with Debian 13

2.1.0 - 2025-06-10

Full changeset and discussions: #56.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Added

  • Enable PM2 to automatically restart Open Terms Archive applications after a reboot

2.0.2 - 2024-06-12

Full changeset and discussions: #46.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Fixed

  • Ensure configuration changes are taken into account on restart
  • Make refined playbook execution work with the start, stop and restart tags

2.0.1 - 2024-06-04

Full changeset and discussions: #45.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Fixed

  • Set up the Git-based databases at the proper locations
  • Make refined playbook execution work with the infrastructure tag

2.0.0 - 2024-05-31

Full changeset and discussions: #41.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Changed

  • Breaking: Replace all playbooks with a single deploy playbook; update your scripts by using ansible-playbook opentermsarchive.deployment.deploy and use tags to refine execution
  • Breaking: Change the federation-api deployment process to be a dependency of the source repository
  • Breaking: Require engine>=2 and federation-api>=v2
  • Breaking: Make ota_source_repository variable mandatory
  • Breaking: Define environment variables in a .env file instead of in inventory variables; move ota_engine_github_token, ota_engine_smtp_password, ota_engine_sendinblue_api_key, and ota_federated_api_smtp_password to a .env file placed next to the inventory file and rename them according to the new naming conventions in engine v2 and federation-api v2
  • Breaking: Rename ota_engine_declarations_branch to ota_source_repository_branch
  • Breaking: Rename ota_engine_declarations_directory to ota_directory
  • Breaking: Extract the PM2 config file pm2.config.cjs; provide this file next to the inventory file
  • Breaking: Remove the ota_engine_restart_delay variable; define this setting directly in the pm2.config.cjs
  • Breaking: Remove the ota_engine_github_bot_private_key variable in favor of the github-bot-private-key file; define the GitHub SSH private key in the github-bot-private-key

Removed

  • Breaking: Remove ota_reverse_proxy_federated_api_path config; define this path in your config/production.json under the key @opentermsarchive/federation-api: { basePath: "" }
  • Breaking: Remove ota_reverse_proxy_engine_path config; define this path in your config/production.json under the key @opentermsarchive/engine: { collection-api: { basePath: "" } }
  • Breaking: Remove obsolete ota_engine_config_path, ota_federated_api_branch, ota_federated_api_directory, and ota_federated_api_repo configs
  • Breaking: Remove obsolete update-declarations tag

1.2.1 - 2024-05-22

Full changeset and discussions: #42.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Fixed

  • Fix dependencies installation

1.2.0 - 2024-04-16

Full changeset and discussions: #39.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Added

  • Enable the deployment of the Open Terms Archive Engine and Federated API applications on a single server; refer to the added playbooks; remove any existing Nginx configurations previously installed by this collection like engine-api, federated-api, ota-engine-api, or ota-federated-api in /etc/nginx/sites-available to avoid conflicts.

1.1.1 - 2024-04-08

Full changeset and discussions: #38.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Changed

  • Update package metadata

1.1.0 - 2024-03-14

Full changeset and discussions: #35.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Changed

  • Enable configuration of engine restart delay with ota_engine_restart_delay variable

1.0.0 - 2024-03-08

Full changeset and discussions: #34.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

No actual code changes were made in this release, but it signifies that the public API can now be considered stable.

0.1.1 - 2024-02-20

Full changeset and discussions: #32.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Fixed

  • Ensure snapshots and versions repositories use correct SSH key

0.1.0 - 2024-02-20

Full changeset and discussions: #30.

Development of this release was supported by the French Ministry for Foreign Affairs through its ministerial State Startups incubator under the aegis of the Ambassador for Digital Affairs.

Changed

  • Breaking: Extract embedded secrets and make them configurable; update your inventory to include secrets through configuration

0.0.16 - 2023-12-04

Development of this release was supported by the NGI0 Entrust Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG CNECT under grant agreement N°101069594.

Changed

  • Rename the federated-api role to federated_api to comply with Ansible Galaxy constraints.

0.0.15 - 2023-12-04

Development of this release was supported by the NGI0 Entrust Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG CNECT under grant agreement N°101069594.

Added

  • Add playbook to setup and deploy the Open Terms Archive federated API

Changed

  • Breaking: Rename deploy playbook to setup the infrastructure and deploy engine to engine.all; update your scripts accordingly
  • Breaking: Rename variable ota_config_path to ota_engine_config_path; update your inventory file accordingly
  • Breaking: Rename variable ota_declarations_directory to ota_engine_declarations_directory; update your inventory file accordingly
  • Breaking: Rename variable ota_declarations_branch to ota_engine_declarations_branch; update your inventory file accordingly
  • Breaking: Rename variable ota_snapshots_branch to ota_engine_snapshots_branch; update your inventory file accordingly
  • Breaking: Rename variable ota_versions_branch to ota_engine_versions_branch; update your inventory file accordingly

Removed

  • Breaking: Remove tag setup; use the application deployment playbook as replacement in your scripts ansible-playbook opentermsarchive.deployment.engine.application
  • Breaking: Remove tag update; use the application deployment playbook as replacement in your scripts ansible-playbook opentermsarchive.deployment.engine.application
  • Breaking: Remove tag engine; use the application deployment playbook as replacement in your scripts ansible-playbook opentermsarchive.deployment.engine.application
  • Breaking: Remove tag infra; use the infrastructure set up playbook as replacement in your scripts ansible-playbook opentermsarchive.deployment.engine.infrastructure

Fixed

  • Ensure that the configuration for the port of the collection metadata API is successfully applied to the Nginx configuration

0.0.14 - 2023-10-11

Fixed

  • Ensure that the Nodesource GPG key import does not get stuck

0.0.13 - 2023-10-06

Changed

  • Upgrade NodeJS to version 20 and NPM to version 10

0.0.12 - 2023-09-08

Fixed

  • Fix MongoDB data directory permissions

0.0.11 - 2023-09-06

Changed

  • Lock pm2 major version

Fixed

  • Ensure NPM version is compatible with NodeJS version

0.0.10 - 2023-07-03

Added

  • Launch API server; expect to have a npm command start:api defined in the declarations package
  • Install NGINX as a reverse proxy to expose the API with a rate limiter

0.0.9 - 2023-04-05

Added

  • Automate linting with GitHub Actions
  • Specification of changelog format

Changed

  • Specification of changelog format is now in CONTRIBUTING

0.0.8 - 2023-01-26

Added

  • Schedule dataset release; expect to have a npm command dataset:schedule defined in the declarations package

0.0.7 - 2023-01-26

Fixed

  • Fix version update in galaxy.yml in the release workflow

0.0.6 - 2022-12-13

Changed

  • Ensure that publishing to Ansible Galaxy is only done when publishing to GitHub is successful

0.0.5 - 2022-12-13

Changed

  • Expect to have a npm command start:schedule define in the declarations package

Fixed

  • Ensure paths for given Git storage configuration are relative to current declarations directory

0.0.4 - 2022-11-08

Added

  • Define default value for ota_config_path

Changed

  • Change namespace from ota to opentermsarchive

0.0.3 - 2022-10-28

Added

  • Add documentation for available variables

Changed

  • Move and consolidate all test-related files in the tests folder.

Removed

  • Print debug output

0.0.2 - 2022-10-28

Changed

  • Fix some lintint errors and warnings
  • Commit galaxy.yml in the release process

0.0.1 - 2022-10-28

Added

  • Automate publishing with GitHub Actions