Repository navigation
Add doc for issue reporter - #227
Merged
Merged
Conversation
✅ Deploy Preview for open-terms-archive-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The engine and the issue reporter each have their own logger options, under the `@opentermsarchive/engine` and `@opentermsarchive/issue-reporter` keys. As the refItem shortcode builds anchors from the option name only, `logger.timestampPrefix`, `logger.smtp.host`, `logger.smtp.port` and `logger.smtp.username` produced duplicate HTML ids on the configuration page, and links to the issue reporter options pointed to the engine ones. Add an optional `anchorPrefix` parameter to the shortcode and use it for all the issue reporter options, so that their anchors stay consistent.
"Until engine v16" could be read as "before v16", while all v16 releases still include the reporter.
Renaming `OTA_ENGINE_GITHUB_TOKEN` would remove the token the engine still uses to publish datasets to GitHub releases, which contradicted the following sentence. On GitLab, the engine now publishes datasets with `OTA_ENGINE_GITLAB_RELEASES_TOKEN` only, so `OTA_ENGINE_GITLAB_TOKEN` can be renamed, as described in OpenTermsArchive/engine#1287.
The engine accepted a reporter configuration nested under a `githubIssues` key and inferred the GitHub type, while the module requires a `type` next to the repositories and fails at startup without it. Stating that the legacy form is not supported did not tell how to convert it, unlike the engine warning and changelog.
The engine selected GitLab publishing with `OTA_ENGINE_GITLAB_TOKEN` while authenticating every request with `OTA_ENGINE_GITLAB_RELEASES_TOKEN`. Since OpenTermsArchive/engine#1287, publishing depends on the releases token only and `OTA_ENGINE_GITLAB_TOKEN` is no longer used.
Since OpenTermsArchive/engine#1287, the GitLab dataset publisher resolves the proxy as the fetcher does, so the proxy variables also apply to dataset publishing. Both also honour the lowercase variables, which take precedence over the uppercase ones.
The proxy mention was removed from the engine variables along with the reporter, while the module still reaches GitLab through `HTTPS_PROXY`. Its GitHub client does not use any proxy. `HTTP_PROXY` is left out, as the module would use it with an agent that does not tunnel to the HTTPS API of GitLab.
The page also documents the variables of the issue reporter and of the Federation API, not only those of the engine.
The command has a single `sync` subcommand, and the description of its `--schedule` option lacked its final period, unlike the other entries.
"In the same directory as the engine" could be read as inside the engine directory in `node_modules`, while the module has to be a dependency of the collection, like the engine.
clementbiron
approved these changes
Oct 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.