Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(layout): add R globally #671

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

clemgbld
Copy link
Contributor

@clemgbld clemgbld commented May 5, 2024

Add r globally to docs

Fixes #661

  • doesn’t work with <script type="module> but works fine with <script>
Capture d’écran 2024-05-05 à 16 06 55

Make sure that you:

  • Typedoc added for new methods and updated for changed
  • Tests added for new methods and updated for changed
  • New methods added to src/index.ts
  • New methods added to mapping.md

We use semantic PR titles to automate the release process!

https://conventionalcommits.org

PRs should be titled following using the format: < TYPE >(< scope >)?: description

Available Types:

  • feat: new functions, and changes to a function's type that would impact users.
  • fix: changes to the runtime behavior of an existing function, or refinements to it's type that shouldn't impact most users.
  • perf: changes to function implementations that improve a functions runtime performance.
  • refactor: changes to function implementations that are neither fix nor perf
  • test: tests-only changes (transparent to users of the function).
  • docs: changes to the documentation of a function or the documentation site.
  • build, ci, style, chore, and revert: are only relevant for the internals of the library.

For scope put the name of the function you are working on (either new or
existing).

Copy link

codesandbox-ci bot commented May 5, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 614739b:

Sandbox Source
remeda-example-vanilla Configuration

Copy link

codecov bot commented May 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.61%. Comparing base (96a4e82) to head (614739b).
Report is 91 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #671      +/-   ##
==========================================
+ Coverage   98.41%   98.61%   +0.20%     
==========================================
  Files         127      154      +27     
  Lines        7954    11130    +3176     
  Branches      724      939     +215     
==========================================
+ Hits         7828    10976    +3148     
- Misses        123      151      +28     
  Partials        3        3              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@clemgbld clemgbld changed the title Add r globally to docs docs(layout): add R globally May 5, 2024
@eranhirsch
Copy link
Collaborator

What version of the library would this import? The version in package.json of the docs project?

@clemgbld
Copy link
Contributor Author

clemgbld commented May 5, 2024

What version of the library would this import? The version in package.json of the docs project?

yes the version of the imported remeda library is the one in the package.json of the docs project

@eranhirsch
Copy link
Collaborator

So we'll need a way to make sure that we bump the version in the docs package.json every time we release a version so that the version we provide doesn't diverge from the docs.

@cjquines, do you have any idea how to achieve this? I think of another step in the GitHub action that releases to npm: just do cd docs && npm install remedy, but that might mean that if the change caused a breakage, we might run into issues.

@cjquines
Copy link
Collaborator

cjquines commented May 5, 2024

but that might mean that if the change caused a breakage, we might run into issues

in that case we should probably fail the publish action anyway?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add "R" or "Remeda" globally to the docs website for easy experiments
3 participants