Skip to content

Fix npm run version#1517

Merged
robmoffat merged 18 commits intofinos:fdc3-web-impl-update-docusaurusfrom
patrocinio:npm-version-2
Feb 20, 2025
Merged

Fix npm run version#1517
robmoffat merged 18 commits intofinos:fdc3-web-impl-update-docusaurusfrom
patrocinio:npm-version-2

Conversation

@patrocinio
Copy link
Contributor

@patrocinio patrocinio commented Feb 14, 2025

Describe your change

Related Issue

fixes #1516

Contributor License Agreement

  • I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

  • Issue: If a change was made to the FDC3 Standard, was an issue linked above?
  • CHANGELOG: Is a CHANGELOG.md entry included?
  • API changes: Does this PR include changes to any of the FDC3 APIs (DesktopAgent, Channel, PrivateChannel, Listener, Bridging)?
    • Docs & Sources: If yes, were both documentation (/docs) and sources updated?

      JSDoc comments on interfaces and types should be matched to the main documentation in /docs
    • Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?

      Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
    • Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?

      The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
      • If yes, was code generation (npm run build) run and the results checked in?

        Generated code will be found at /src/api/BrowserTypes.ts and/or /src/bridging/BridgingTypes.ts
  • Context types: Were new Context type schemas created or modified in this PR?
    • Were the field type conventions adhered to?
    • Was the BaseContext schema applied via allOf (as it is in existing types)?
    • Was a title and description provided for all properties defined in the schema?
    • Was at least one example provided?
    • Was code generation (npm run build) run and the results checked in?

      Generated code will be found at /src/context/ContextTypes.ts
  • Intents: Were new Intents created in this PR?

@patrocinio patrocinio requested a review from a team as a code owner February 14, 2025 19:31
@netlify
Copy link

netlify bot commented Feb 14, 2025

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit 1be6eda
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/67af9a082b5c040008bce676
😎 Deploy Preview https://deploy-preview-1517--fdc3.netlify.app
📱 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.

@kriswest
Copy link
Contributor

kriswest commented Feb 18, 2025

@patrocinio thanks for the contribution!

@robmoffat @TheJuanAndOnly99 I see the easyCLA check passed, but not the usual comment. Do we know the check actually ran?

@TheJuanAndOnly99
Copy link
Member

/easycla

@TheJuanAndOnly99
Copy link
Member

Hey @kriswest I raised a ticket with the EasyCLA team (as I can't see the inner workings of the bot) asking them to verify that the check actually ran. Please standby for their response.

@kriswest
Copy link
Contributor

kriswest commented Feb 18, 2025

@patrocinio and @robmoffat + @finos/fdc3-maintainers

We appear to have further problems with this script - to test it fully you have to manually update the version number in the version script to "2.2":

    "version": "cross-env-shell VERSION=2.2 npm run version-run",
  • We need to add npm run prebuild as the first script run in the version-run task (to ensure schema files and toolbox apps are copied in from respective packages and docs page generation run).
  • version number replacement in the schema files is not working - all schemas under website/static/schemas/2.2 should have $id fields prefixed with https://fdc3.finos.org/schemas/2.2/. (rather than next as the last token)
  • An actual documentation version is not being created - I'm not seeing a call to npm run docusaurus docs:version $VERSION which would do that

Updating two of the scripts as follows seems to resolve that:

    "version-run": "cross-env-shell \"echo Creating version: \\$VERSION... && npm run prebuild && npm run docusaurus docs:version $VERSION && npm run version:docs-schema && npm run version:docs-replace && npm run version:schemas && npm run version:schemas-replace && npm run version:appd-replace\"",
    "version:schemas-replace": "cross-env-shell replace-in-files --string=/schemas/next --replacement=/schemas/$VERSION static/schemas/$VERSION/**/*.schema.json",

That gets the version created, and the schemas renamed correctly, version number applied to standard Part overview pages. I can't currently commit these changes but I'm happy for someone else to add them to this or another PR.

Finally, after the proposed fixes, the version menu at the top of the page is still missing the new version... That seems to be manually configured now in website/docusaurus.config.js (themeConfig.items[7]) where that used to come from config. We should probably be switching over to the navbar docsVersionDropdown item to do that for us.

@TheJuanAndOnly99
Copy link
Member

@kriswest I have confirmed with the EasyCLA team that the checks ran correctly.

@robmoffat robmoffat changed the base branch from main to fdc3-web-impl-update-docusaurus February 20, 2025 11:13
@robmoffat robmoffat merged commit 9fef2db into finos:fdc3-web-impl-update-docusaurus Feb 20, 2025
19 of 20 checks passed
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.

npm run version in website/ directory is failing

6 participants