Skip to content

Commit

Permalink
Merge pull request meteor#13265 from meteor/feature/update-faq-v3
Browse files Browse the repository at this point in the history
Update Meteor 3 FAQ
  • Loading branch information
denihs authored Aug 1, 2024
2 parents d0a04c8 + 8e5196f commit 22fbca5
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ The migration will look like this:
```js
// in you package.js
Package.onUse((api) => {
api.versionsFrom(['1.10', '2.3', '3.0-rc.2']);
api.versionsFrom(['1.10', '2.3', '3.0']);
// ^^^^^^^ for testing your package with meteor 3.0

api.versionsFrom(['1.10', '2.3', '3.0']);
// ^^^^^^^ for meteor 3.0
});
```

Then you can publish your package and test it with Meteor 3.0, by running `meteor publish --release=3.0-rc.2`.
Then you can publish your package and test it with Meteor 3.0, by running `meteor publish --release=3.0.1`.


## Changes for packages that do not use Meteor packages that had breaking change
Expand All @@ -33,7 +33,7 @@ by adding the following line to your `package.js`:
```js
// in you package.js
Package.onUse((api) => {
api.versionsFrom(['1.10', '2.3', '3.0-rc.2']);
api.versionsFrom(['1.10', '2.3', '3.0']);
// ^^^^^^^ for testing your package with meteor 3.0

api.versionsFrom(['1.10', '2.3', '3.0']);
Expand Down
8 changes: 2 additions & 6 deletions v3-docs/v3-migration-docs/frequently-asked-questions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ from Ben Newman and this Stack Overflow [answer](https://stackoverflow.com/a/408

## What is the Meteor v3 release schedule?

Our current plan is to release Meteor v3 until Q2 2024. This is subject to change as we progress through the development of Meteor v3.
Meteor 3 official version is already out! You can check our posts about it on the [Forums](https://forums.meteor.com/t/its-official-meteor-3-0-official-release-is-out/61860) and [blog](https://dev.to/meteor/meteor-3-is-officially-here-3gml).

## Will MongoDB Collection Methods be removed from the client?

Expand Down Expand Up @@ -98,9 +98,7 @@ You can check more information on the [react page](../front-end/react.md).

## When will Blaze be ready for version 3.0?

The team considered Blaze adjustments to version 3.0 done, version 2.9 and upper are with all features regarding async APIs.

You can check more information on the [Blaze page](../front-end/blaze.md).
Blaze 3 is out and compatible with Meteor 3. You can check the post about it [here](https://forums.meteor.com/t/blaze-3-is-out/61861).

## When will XYZ package be ready for version 3.0?

Expand All @@ -113,5 +111,3 @@ For those packages that are not in the core but are maintained by the [community
we hope that the community can work on them, but if for some reason that is not possible,
you can always ping us on [Slack](https://join.slack.com/t/meteor-community/shared_invite/zt-28aru814j-AwswQGt2D1xIXurvmtJvug) or in the [Forums](https://forums.meteor.com/).

Following the official release of Meteor 3.0, we plan to add new packages to the core and migrating them to Meteor 3.0.

14 changes: 7 additions & 7 deletions v3-docs/v3-migration-docs/guide/publishing-packages.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Publishing Packages

Publishing a Meteor package involves a few key steps, including setting up your package, testing it, and finally publishing it to the Meteor package repository. Here's a brief guide on how to publish Meteor packages using Meteor 3, specifically with the `meteor publish --release=3.0-rc.2` command.
Publishing a Meteor package involves a few key steps, including setting up your package, testing it, and finally publishing it to the Meteor package repository. Here's a brief guide on how to publish Meteor packages using Meteor 3, specifically with the `meteor publish --release=3.0.1` command.

### Prerequisites
- Ensure you have Meteor 3 installed. You can check your Meteor version and automatically download it if it's missing:
```bash
meteor --version --release=3.0-rc.2
meteor --version --release=3.0.1
```
- Have a Meteor developer account. You can create one at [Meteor's official website](https://www.meteor.com/).
Expand Down Expand Up @@ -35,7 +35,7 @@ Package.describe({
});
Package.onUse(function(api) {
api.versionsFrom('3.0-rc.2');
api.versionsFrom('3.0');
api.use('ecmascript');
api.mainModule('my-package.js');
});
Expand All @@ -51,7 +51,7 @@ Package.onTest(function(api) {
If the package is also intended to work with Meteor 2 you can use:

```javascript
api.versionsFrom(['2.3', '3.0-rc.2']);
api.versionsFrom(['2.3', '3.0']);
```

3. **Create the main module file:**
Expand Down Expand Up @@ -87,10 +87,10 @@ meteor test-packages ./ --driver-package meteortesting:mocha
Once your package is ready and tested, you can publish it using the following command:

```bash
meteor publish --release=3.0-rc.2
meteor publish --release=3.0.1
```

You can replace `3.0-rc.2` with the appropriate release version. If you omit the `--release` flag, it will default to the latest official Meteor version, which at the time of this writing is Meteor 2. That way packages published without specifying a release will not be compatible with Meteor 3, as there will probably be a `fibers` related error.
You can replace `3.0.1` with the appropriate release version. If you omit the `--release` flag, it will default to the latest official Meteor version, which at the time of this writing is Meteor 2. That way packages published without specifying a release will not be compatible with Meteor 3, as there will probably be a `fibers` related error.

- **Login if prompted:**
You will be asked to log in with your Meteor developer account credentials if you aren't already logged in.
Expand All @@ -110,4 +110,4 @@ meteor add user:package
- **Documentation:** Provide thorough documentation in the `README.md` file to help users understand how to use your package.
- **Git Repository:** Keep your package source code in a version-controlled repository like GitHub for easy collaboration and updates.
By following these steps, you should be able to publish your Meteor packages with Meteor 3 successfully. Happy coding!
By following these steps, you should be able to publish your Meteor packages with Meteor 3 successfully. Happy coding!
8 changes: 4 additions & 4 deletions v3-docs/v3-migration-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ This guide is for users with Meteor 2.x projects understand the changes between

## What's the status of version 3.0?

Meteor 3.0 is currently in its Release Candidate (RC) phase, a nearly final version ready for final testing ahead of the official launch.
Meteor 3.0 is currently in its official version!

**Latest version:** `3.0-rc.10` <br/>
**Latest version:** `3.0.1` <br/>
**Node.js version:** `20.15.1 LTS` <br/>
**NPM version:** `10.7.0`

Expand All @@ -20,15 +20,15 @@ Meteor 3.0 is currently in its Release Candidate (RC) phase, a nearly final vers
You can create a new Meteor 3.0 project by running the command below:

```bash
meteor create my-new-project --release 3.0-rc.4
meteor create my-new-project --release 3.0.1
```

## How to upgrade from Meteor 2.x?

You can upgrade your Meteor 2.x project by running the command below inside your project folder:

```bash
meteor update --release 3.0-rc.4
meteor update --release 3.0.1
meteor reset # resets project to a fresh state
```

Expand Down

0 comments on commit 22fbca5

Please sign in to comment.