RosaeNLG / rosaenlg

RosaeNLG is a Natural Language Generation library for node.js and browser rendering, based on the Pug template engine.
https://rosaenlg.org
Apache License 2.0
92 stars 21 forks source link

lunr search extension for doc website #198

Closed ludans closed 1 year ago

ludans commented 1 year ago

Thanks for contributing!

Please check if the PR fulfills these requirements 👌:

Also remember: each commit MUST contain a sign off message (see CONTRIBUTING.md) 🙄

Indicate related issue:

issue #193

Explain what is done, scope, limitations etc.

antora lunr extension for search

Does this PR introduce a breaking change? 😁

no change on RosaeNLG engine (just the doc search)

gitguardian[bot] commented 1 year ago

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
| GitGuardian id | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [7734188](https://dashboard.gitguardian.com/incidents/7734188?occurrence=108886171) | Generic High Entropy Secret | 5de85ea960e7872fe07e0853d3149347641412e1 | packages/rosaenlg-antora-ui/src/partials/docsearch.hbs | [View secret](https://github.com/RosaeNLG/rosaenlg/commit/5de85ea960e7872fe07e0853d3149347641412e1#diff-24f91cd4cc1c410cc7ab93f98207cc7f3df9d579c16c13f4a5c167c2c067aaffL5) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secret safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate this secret](https://docs.gitguardian.com/secrets-detection/detectors/generics/generic_high_entropy_secret#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!