-
Notifications
You must be signed in to change notification settings - Fork 76
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
fix: nightly fuels-ts docs API changes breaking the CI #584
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
95c09c5
add script to replace `DOCS_API_URL`
nedsalk d2d0c02
always update fuels-ts nightly version
nedsalk d860813
have the patching work for `dev` as well
nedsalk 9e617f8
Merge branch 'master' into ns/fix/ts-api-docs-integration
calldelegation 2a8e35f
Merge branch 'master' into ns/fix/ts-api-docs-integration
arboleya 46e8666
Merge branch 'master' into ns/fix/ts-api-docs-integration
arboleya File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
import { readFileSync, writeFileSync } from 'fs'; | ||
import { join } from 'path'; | ||
import { globby } from 'globby'; | ||
import { cwd } from 'process'; | ||
|
||
const pathsAndUrls = new Map([ | ||
[ | ||
join(cwd(), 'docs/fuels-ts/apps/docs/src'), | ||
'https://fuels-ts-docs-api.vercel.app', | ||
], | ||
[ | ||
join(cwd(), 'docs/nightly/fuels-ts/apps/docs/src'), | ||
'https://fuels-ts-docs-api-nightly.vercel.app', | ||
], | ||
]); | ||
|
||
for (const [docsPath, url] of pathsAndUrls) { | ||
const filepaths = await globby(['**.md'], { | ||
cwd: docsPath, | ||
}); | ||
|
||
filepaths.forEach((filepath) => { | ||
const path = join(docsPath, filepath); | ||
const file = readFileSync(path).toString(); | ||
|
||
writeFileSync(path, file.replace(/DOCS_API_URL/g, url)); | ||
}); | ||
} |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This addition ensures that every call to the
update-nightly
workflow updates the nightlyfuels-ts
version. I only addedfuels-ts
and not the other repositories that have nightly versions because:fuels-ts
-specific,fuels-ts
is the only repository in theversions.json
file that calls theupdate-nightly
workflow (reference).Important
This will still require manual merging of the nightly docs PR - nothing changed about that.
Handling of the other nightly versions more appropriately would be done via