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

fix: nightly fuels-ts docs API changes breaking the CI #584

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

Conversation

nedsalk
Copy link

@nedsalk nedsalk commented Jan 28, 2025

Relates to FuelLabs/fuels-ts#3572 and to be merged before

so that the PR in the TS SDK can be verified to work. I already tested it locally by checking out that PR in docs/fuels-ts and docs/nightly/fuels-ts.

@nedsalk nedsalk added the documentation Improvements or additions to documentation label Jan 28, 2025
@nedsalk nedsalk self-assigned this Jan 28, 2025
@@ -35,6 +35,7 @@ export async function updateSubmodules(newDefaultVersions, newNightlyVersions) {
'docs/nightly/fuel-specs',
'docs/nightly/fuel-graphql-docs',
'docs/nightly/migrations-and-disclosures',
'docs/nightly/fuels-ts',
Copy link
Author

@nedsalk nedsalk Jan 29, 2025

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 nightly fuels-ts version. I only added fuels-ts and not the other repositories that have nightly versions because:

  1. I want to keep the focus on the API docs issue which is fuels-ts-specific,
  2. fuels-ts is the only repository in the versions.json file that calls the update-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

@nedsalk nedsalk changed the title add script to replace DOCS_API_URL for fuels-ts API docs fix: nightly fuels-ts docs API changes breaking the CI Jan 29, 2025
@nedsalk nedsalk marked this pull request as ready for review January 29, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants