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(commit-and-tag-version): auto-bump version in usage-guide #3250

Merged
merged 5 commits into from
Nov 14, 2024

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Nov 4, 2024

Automates another step from the release process:

Update docs/guide/usage.md version pin

Preview

Limitations

Doesn't seem to work on windows maybe because it launches a new CMD instead of (git-)bash
(I don't expect us to do releases locally again though)

Alternatives Considered

I also considered using a js script for the replacing, but that requires converting the .versionrc.json to .versionrc.js.
It might be possible to use a ts file instead, if we tsc "compile" it before delegating to commit-and-tag-version in pnpm run release.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
ash2k Mikhail Mazurskiy
@ST-DDT ST-DDT added p: 1-normal Nothing urgent c: infra Changes to our infrastructure or project setup labels Nov 4, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Nov 4, 2024
@ST-DDT ST-DDT requested review from a team November 4, 2024 23:39
@ST-DDT ST-DDT self-assigned this Nov 4, 2024
Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit c2bd8aa
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/67366e918716d40008718260
😎 Deploy Preview https://deploy-preview-3250.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@xDivisionByZerox
Copy link
Member

Cool that you found this, but could you guide me towards documentation on the "scripts" property? I cannot seem to find any references towards that in their documentation. 🤔

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 6, 2024

Its part of the commit and tag version plugin config:

I'm not sure why there are two different documentations and I consider this one hard to read/understand.

You can try the script in a linux docker container.

  • pnpm run release

Verified

This commit was signed with the committer’s verified signature. The key has expired.
ash2k Mikhail Mazurskiy
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (ef24bff) to head (c2bd8aa).
Report is 1 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #3250      +/-   ##
==========================================
- Coverage   99.96%   99.95%   -0.01%     
==========================================
  Files        2806     2806              
  Lines      217144   217144              
  Branches      974      971       -3     
==========================================
- Hits       217062   217042      -20     
- Misses         82      102      +20     

see 2 files with indirect coverage changes

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@ST-DDT ST-DDT added this pull request to the merge queue Nov 14, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 14, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@ST-DDT ST-DDT enabled auto-merge (squash) November 14, 2024 21:41
@ST-DDT ST-DDT merged commit a54c1ed into next Nov 14, 2024
23 checks passed
@ST-DDT ST-DDT deleted the infra/auto-bump/usage-guide-version branch November 14, 2024 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: infra Changes to our infrastructure or project setup p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants