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

infra(docs): add docs diff script #1755

Merged
merged 26 commits into from
Feb 1, 2023
Merged

infra(docs): add docs diff script #1755

merged 26 commits into from
Feb 1, 2023

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Jan 18, 2023

Fixes #1754

Adds CI notification about changed api doc pages.

  • Generates a hash for each module and their methods
  • Publishes it on our website as (hidden) json
  • Diff the local hash with the remote ones
  • Embed into CI Will be done in a later PR

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug c: infra Changes to our infrastructure or project setup labels Jan 18, 2023
@ST-DDT ST-DDT self-assigned this Jan 18, 2023
@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 18, 2023

Blocked by #859

@ST-DDT ST-DDT added the s: on hold Blocked by something or frozen to avoid conflicts label Jan 18, 2023
@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 18, 2023

@codecov
Copy link

codecov bot commented Jan 18, 2023

Codecov Report

Merging #1755 (3d3ca57) into next (de7ed2e) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #1755      +/-   ##
==========================================
- Coverage   99.63%   99.62%   -0.01%     
==========================================
  Files        2346     2346              
  Lines      235002   235002              
  Branches     1132     1129       -3     
==========================================
- Hits       234149   234127      -22     
- Misses        831      853      +22     
  Partials       22       22              
Impacted Files Coverage Δ
src/modules/internet/user-agent.ts 88.75% <0.00%> (-5.92%) ⬇️
src/modules/location/index.ts 97.54% <0.00%> (-0.38%) ⬇️

@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 19, 2023

Also blocked by #1759

scripts/apidoc/diff.ts Outdated Show resolved Hide resolved
scripts/apidoc/diff.ts Outdated Show resolved Hide resolved
scripts/apidoc/utils.ts Outdated Show resolved Hide resolved
@Shinigami92 Shinigami92 self-requested a review January 20, 2023 20:26
scripts/diff.ts Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 23, 2023

Waiting for #1757 to be merged.

@ST-DDT ST-DDT requested a review from a team January 29, 2023 23:49
Shinigami92
Shinigami92 previously approved these changes Jan 30, 2023
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will approve for now to not block it, but theoretically you could think about to improve this much by using js URL class
Even file:// seems to be supported, and this way you could extract and handle stuff more precise like line 38 source.startsWith('https://') could become source.protocol === 'https:'

but you could also do this in a new PR and iterate

Shinigami92
Shinigami92 previously approved these changes Jan 30, 2023
@ST-DDT ST-DDT requested a review from a team January 30, 2023 14:55
@ST-DDT ST-DDT enabled auto-merge (squash) February 1, 2023 13:23
@ST-DDT ST-DDT merged commit 9c3618d into next Feb 1, 2023
@ST-DDT ST-DDT deleted the docs/diff-notification branch February 1, 2023 22:04
matthewmayer pushed a commit to matthewmayer/faker that referenced this pull request Feb 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation c: infra Changes to our infrastructure or project setup p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add api docs diff to the PR
3 participants