-
Notifications
You must be signed in to change notification settings - Fork 195
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: remove all yml processing and files
- Loading branch information
1 parent
c4da04b
commit 189c57d
Showing
117 changed files
with
24 additions
and
25,588 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,12 +42,7 @@ Before removing the component from the codebase, we need to flag the component a | |
status: { type: "deprecated" } | ||
}, | ||
``` | ||
3. Update the status of the component to `Deprecated` in the `*.yml` file. Add any additional migration notes to the `deprecationNotice` keyword. i.e., | ||
```yaml | ||
name: Quick actions | ||
status: Deprecated | ||
deprecationNotice: Use an [action bar](actionbar.html) to allow users to perform actions on either a single or multiple items at the same time, instead. | ||
``` | ||
3. Add a notice to the documentation page that reads: `**This component is deprecated.**`. This can be done in either the `*.stories.js` file or the `*.mdx` file, if it exists. Add any additional migration notes that were provided by the design team. | ||
4. Commit these changes and open a pull request to the main branch. i.e., `git commit -m "chore(quickaction): prepare for deprecation"`. | ||
5. Once the pull request is approved, merge the changes into the main branch and publish the update to the package registry. | ||
|
||
|
@@ -58,7 +53,7 @@ At this point you can choose to either immediate move on to the next steps or gi | |
Once the deprecation notice has been communicated and the above steps completed, we can remove the component from the codebase safely without breaking local references. | ||
|
||
1. Create a new folder with the component name in `.storybook/deprecated`, i.e., `.storybook/deprecated/quickaction`. | ||
2. Copy `*.stories.js` and `metadata/*.yml` into the new folder (directly, not nested inside subfolders). | ||
2. Copy `*.stories.js` and `*.mdx` into the new folder (directly, not nested inside subfolders). | ||
3. Delete the package from the `components` directory. | ||
4. Add the deprecated component's package and last version to the monorepo's root package.json. i.e., `"@spectrum-css/quickaction": "^3.1.1",`. | ||
5. Reach out to one of the package maintainers to officially deprecate the package in the package registry with the provided deprecation notice from design. Do not try to run the deprecation command unless you know that you have publishing permissions on npm. i.e., `npm deprecate @spectrum-css/[email protected] "This package has been deprecated. Use an action bar to allow users to perform actions on either a single or multiple items at the same time, instead."`. | ||
|
Oops, something went wrong.