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

5.42.0 - Minor Improvements #4479

Merged
merged 14 commits into from
Jan 9, 2025
Merged

5.42.0 - Minor Improvements #4479

merged 14 commits into from
Jan 9, 2025

Conversation

adrians5j
Copy link
Member

@adrians5j adrians5j commented Jan 7, 2025

Changes

1. Example Extensions - Introduced Optional extension.json

From now on, upon downloading an example extension from our webiny-examples repo, the webiny extension command will also try to look for the newly introduced extension.json file, which is basically a file that can contain additional information about the extension. The file is optional, and can be placed by the extensions folder when creating an example extension, for example page-builder/custom-page-elements.

Note

The TS interface that the extension.json adheres to can be found here.

2. Custom Next Steps / Additional Notes via extension.json

Via the nextSteps and additionalNotes properties in extension.json file, we can now define additional messages that will be shown to the user once the extension has been downloaded / linked.

For example, before, when downloading the Smart SEO extension, users would see the following:

image

Now, because I've defined additional Next Steps and Additional Notes messages via extension.json, users will see them at the end of the download / link process:

image

3. Link To the Extensions Article In extensions.ts / extensions.tsx Files

In all extensions.ts and Extensions.tsx files, I've added the comment:

// Learn more about extensions: https://webiny.link/extensions

We had a case where user ended up in one of these files, and was confused what this file is for. With the link in plae, users will be able to quickly learn what this file really is.

4. Removed apps/api/graphql/src/types.ts File

With 5.42.0, newly created Webiny projects will no longer contain the apps/api/graphql/src/types.ts file.

This is basically because the file only contained one type, and that was the Context interface (example). The interface is no longer needed, because it's actually exported from the @webiny/api-serverless-cms package and can be imported from there.

How Has This Been Tested?

Manually.

Documentation

Not needed.

@webiny-bot webiny-bot added this to the 5.42.0 milestone Jan 7, 2025
@adrians5j
Copy link
Member Author

adrians5j commented Jan 7, 2025

/cypress

@adrians5j adrians5j marked this pull request as ready for review January 8, 2025 06:02
@adrians5j
Copy link
Member Author

/cypress

Copy link

github-actions bot commented Jan 8, 2025

Cypress E2E tests have been initiated (for more information, click here). ✨

@adrians5j
Copy link
Member Author

/cypress

Copy link

github-actions bot commented Jan 9, 2025

Cypress E2E tests have been initiated (for more information, click here). ✨

@adrians5j adrians5j merged commit c82b918 into next Jan 9, 2025
18 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.

2 participants