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

Advance RFC #0831 Standardize use of scripts in package.json for common tasks to Stage Ready for Release #959

Merged
merged 5 commits into from
Apr 17, 2024

Conversation

emberjs-rfcs-bot
Copy link
Collaborator

@emberjs-rfcs-bot emberjs-rfcs-bot commented Sep 15, 2023

Advance #831 to the Ready For Release Stage

Summary

This pull request is advancing the RFC to the Ready For Release Stage.

An FCP is required before merging this PR to advance.

Upon merging this PR, automation will open a draft PR for this RFC to move to the Released Stage.

Ready for Release Stage Description

This stage is complete when the implementation is complete according to plan outlined in the RFC, and is in harmony with any changes in Ember that have occurred since the RFC was first written. This includes any necessary learning materials. At this stage, features or deprecations may be available for use behind a feature flag, or with an optional package, etc.

For codebase changes, there are no open questions that are anticipated to require breaking changes; the Ember team is ready to commit to the stability of any interfaces exposed by the current implementation of the feature.

This stage should include a list of criteria for determining when the proposal can be considered Recommended after being Released.

An FCP is required to move into this stage.

Each Ember core team will be requested as a reviewer on the PR to move into this stage. A representative of each team adds a review. If a team does not respond to the request, and after the conclusion of the FCP, it is assumed that the release may proceed.

Checklist to move to Ready for Release

  • Implementation is complete according to plan outlined in the RFC, with any adjustments noted in the RFC
  • Any necessary learning materials have been updated
  • The Ember team is ready to commit to the stability of any interfaces exposed by the current implementation of the feature. This is the go/no go decision for any feature flags, but the flags should only be turned on when moving to Released.
  • Criteria for moving to the Recommended Stage has been filled out
  • This PR has been converted from a draft to a regular PR and the Final Comment Period label has been added to start the FCP
  • Each team has been added as a reviewer to the PR at the start of the FCP. Reviews are not required by the end of the FCP. This is a notification step.
    • Framework @emberjs/framework
    • Data @emberjs/ember-data-core
    • CLI @emberjs/cli
    • Learning @emberjs/learning-core
    • Typescript @emberjs/typescript-core
    • Steering @emberjs/steering

Criteria for moving to Recommended (required)

A set of criteria for moving this RFC to the Recommended Stage, following release:

  1. N/A

Track Implementation

  1. Guides updated to use npm start over ember s and npm test over ember test update all ember server to npm start ember-learn/guides-source#1998
  2. Tutorial updated to use npm start over ember s Switch ember serve(r) -> npm start ember-learn/super-rentals-tutorial#235
  3. Tutorial updated to use npm test over ember test
  4. Readme blueprint updated [ENHANCEMENT] Use packager commands in CONTRIBUTING.md and README.md files in app and addon blueprints ember-cli/ember-cli#9514
  5. cli guides updated (Mention npm scripts, per RFC-831 ember-learn/cli-guides#302)

<-- Use this section to track implementation of the RFC -->

@emberjs-rfcs-bot emberjs-rfcs-bot added RFC Advancement S-Ready for Release PR to move to the Ready for Release Stage labels Sep 15, 2023
@wagenet wagenet changed the title Advance RFC #0831 "<RFC title>" to Stage Ready for Release Advance RFC #0831 Standardize use of scripts in package.json for common tasks to Stage Ready for Release Sep 22, 2023
@wagenet
Copy link
Member

wagenet commented Sep 22, 2023

@jenweber @locks is one of you championing this?

@ef4
Copy link
Contributor

ef4 commented Sep 29, 2023

Open PR to ember-cli readme: ember-cli/ember-cli#9514

@ef4
Copy link
Contributor

ef4 commented Oct 6, 2023

We discussed whether to add a switcher to the docs, clarified that this is just a nice-to-have but it is technically feasible.

@jenweber
Copy link
Contributor

jenweber commented Oct 6, 2023

I can’t champion this due to availability, but I’m helping out with the PRs to implement pieces. If someone else is willing to champion it, that would be awesome.

@ef4
Copy link
Contributor

ef4 commented Oct 13, 2023

@NullVoxPopuli to help land ember-cli/ember-cli#9514

@ef4
Copy link
Contributor

ef4 commented Oct 27, 2023

This needs a PR to guides changing ember serve to npm serve and ember test to npm test, etc.

@ef4
Copy link
Contributor

ef4 commented Dec 1, 2023

We still only need a relatively shallow guides update here. This might be a good candidate to just hit together during RFC review.

@kategengler
Copy link
Member

The tutorial does not use ember test but does use ember test -s -- do we want to make this npm run test:ember -s?

@ef4
Copy link
Contributor

ef4 commented Dec 15, 2023

RFC review meeting looked over this and we're fine with just changing ember test to npm test whereas ember test -s is a specialized command that isn't a perfect fit for npm test so it can stay as is.

Progress has been made in the tutorial, still need updates to guides and cli-guides.

@ef4
Copy link
Contributor

ef4 commented Jan 5, 2024

Tutorial changes are now merged, guides and cli-guides still need implementation.

@achambers
Copy link
Contributor

Tutorial changes are now merged, guides and cli-guides still need implementation.

CLI Guides are done. Just Guides to go.

@ef4
Copy link
Contributor

ef4 commented Mar 29, 2024

ember-learn/guides-source#1998 seems ready to go.

@achambers achambers marked this pull request as ready for review April 10, 2024 14:29
@achambers achambers requested review from a team April 10, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants