Skip to content

Commit

Permalink
chore: remove all yml processing and files
Browse files Browse the repository at this point in the history
  • Loading branch information
castastrophe committed Nov 1, 2024
1 parent c4da04b commit 189c57d
Show file tree
Hide file tree
Showing 117 changed files with 24 additions and 25,588 deletions.
6 changes: 3 additions & 3 deletions .github/GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ _to-do_: This needs to diff the actual content of the files as well. Right now w
Runs stylelint or eslint if any relevant assets have been updated in this PR.
##### 📝 Publish site
##### 📝 Publish documentation site
After the build and visual regression tests have passed, this will build the docs site and publish it to Netlify.
After the build and visual regression tests have passed, this will build the documentation site and publish it to Netlify.
##### 📸 Visual regression testing
Expand All @@ -93,7 +93,7 @@ Builds the `main` branch and outputs the compiled assets as artifacts.
##### 📝 2. Publish site
Publish the docs site to Netlify.
Publish the documentation site to Netlify.
##### 📸 3. Visual regression testing
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,8 @@ jobs:
# -------------------------------------------------------------
publish_site:
name: Publish
# The build step ensures we are leveraging the cache for the build
needs: [vrt]
# Note: the goal here is to allow vrt to be skipped but still require the build to succeed
if: ${{ always() }}
uses: ./.github/workflows/publish-site.yml
with:
deploy-message: ${{ github.event.pull_request.title }}
alias: pr-${{ github.event.number }}
# Only pass the storybook url if the vrt was successful
storybook-url: ${{ needs.vrt.outputs.storybook-url || '' }}
secrets: inherit
5 changes: 0 additions & 5 deletions .github/workflows/production.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ name: Build and verify production
# - Publish the PR branch to Netlify
# -------------------------------------------------------------


on:
push:
branches: [main, spectrum-two]
Expand Down Expand Up @@ -62,11 +61,7 @@ jobs:
# -------------------------------------------------------------
publish_site:
name: Publish
# The build step ensures we are leveraging the cache for the build
needs: [vrt]
uses: ./.github/workflows/publish-site.yml
with:
storybook-url: ${{ needs.vrt.outputs.storybook-url || '' }}
secrets: inherit

todo_to_issue:
Expand Down
12 changes: 2 additions & 10 deletions .github/workflows/publish-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ on:
alias:
required: false
type: string
storybook-url:
required: false
type: string
default: ''
workflow_call:
inputs:
deploy-message:
Expand All @@ -24,10 +20,6 @@ on:
alias:
required: false
type: string
storybook-url:
required: false
type: string
default: ''

permissions:
contents: read
Expand Down Expand Up @@ -75,9 +67,9 @@ jobs:
run: yarn install --immutable

## --- BUILD --- ##
- name: Build site
- name: Build storybook
shell: bash
run: yarn build:site
run: yarn build:docs

## --- DEPLOY WEBSITE TO NETLIFY --- ##
- name: Deploy
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/vrt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
exitOnceUploaded: true
onlyChanged: true
traceChanged: true
untraced: ".github/actions/*/package.json site/package.json generator/package.json"
untraced: ".github/actions/*/package.json generator/package.json"
diagnostics: true
autoAcceptChanges: "main"
# Lets VRT pass without running so as not to waste snapshots
Expand Down
15 changes: 0 additions & 15 deletions .storybook/deprecated/cyclebutton/cyclebutton.yml

This file was deleted.

47 changes: 0 additions & 47 deletions .storybook/deprecated/quickaction/quickaction.yml

This file was deleted.

104 changes: 0 additions & 104 deletions .storybook/deprecated/searchwithin/searchwithin.yml

This file was deleted.

76 changes: 0 additions & 76 deletions .storybook/deprecated/splitbutton/splitbutton.yml

This file was deleted.

9 changes: 2 additions & 7 deletions .storybook/guides/deprecation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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."`.
Expand Down
Loading

0 comments on commit 189c57d

Please sign in to comment.