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

chore: remove netlify from codebase #1832

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .github/workflows/deploy-docs-to-netlify.yml

This file was deleted.

34 changes: 0 additions & 34 deletions .github/workflows/manual-deploy-docs.yml

This file was deleted.

28 changes: 0 additions & 28 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,34 +43,6 @@ jobs:
run: git tag -a v$(./.github/workflows/calculateVersion.sh) -m v$(./.github/workflows/calculateVersion.sh)
- name: Push tags
run: git push origin v$(./.github/workflows/calculateVersion.sh)
deploy-docs:
needs: release
if: "startsWith(github.event.head_commit.message, 'chore(release)')"
runs-on: ubuntu-latest
name: Deploy docs to Netlify
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Node 22
uses: actions/setup-node@v4
with:
node-version: '22'
- name: Install netlify-cli
run: npm install --save-dev [email protected]
- name: Install packages.
run: npm ci
- name: Set up project.
run: npm run bootstrap
- name: Build docs-app.
run: npm run build:docs
- name: Copy redirects config file to the __build__ directory.
run: cp ./packages/__docs__/_redirects ./packages/__docs__/__build__
- name: Deploy built docs-app to Netlify.
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
run: npx netlify deploy --prod --dir ./packages/__docs__/__build__
ssr-regression:
needs: release
runs-on: ubuntu-latest
Expand Down
19 changes: 2 additions & 17 deletions docs/contributor-docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,28 +168,13 @@ git push origin v11_maintenance

Update the fields in the file `./packages/__docs__/versions.json` with the latest version and the maintenance branch map. Remove old unsupported versions if they are no longer needed and you don't want them to appear in the docs page version selector.

##### 3. Add redirect for the legacy docs

Add a new line to the file `./packages/__docs__/_redirects` to redirect the legacy docs. If the current major version is 11, then:

```text
---
type: code
---
/v11/* https://v11--preview-instui.netlify.app/:splat 200
```

##### 4. Update version references in the docs app
##### 3. Update version references in the docs app

1. In `docs/getting-started/usage.md` update the version in the code snippet for `package.json`
2. In `packages/__docs__/src/Hero/index.tsx` update the url and title of the Upgrade Guide button
3. In `packages/__docs__/src/Hero/index.tsx` update the url and title of the Upgrade Guide link in the "What's new?" section
4. In `packages/__docs__/src/CodeSandboxButton/index.tsx` update the `@instructure/` dependencies to the latest version

##### 5. Do a release like it was a minor update
##### 4. Do a release like it was a minor update

Follow the same process as it's described above. The `npm run bump` command should automatically recognise that there were a breaking commit and it should be a major version change.

##### 6. Deploy the docs for the maintenance branch

Make sure that previous versions of the docs are accessible. If not, deploy them on Netlify using the `Docs deploy to Netlify` GitHub action.
4 changes: 0 additions & 4 deletions packages/__docs__/_redirects

This file was deleted.

11 changes: 0 additions & 11 deletions packages/__docs__/src/Hero/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -275,17 +275,6 @@ class Hero extends Component<HeroProps> {
</Link>
</List.Item>
</List>
<Heading as="h3" level="h2" margin="none none medium">
Acknowledgements
</Heading>
<View as="p" margin="none none small">
<a href="https://www.netlify.com">
<img
src="https://www.netlify.com/img/global/badges/netlify-dark.svg"
alt="Deploys by Netlify"
/>
</a>
</View>
</View>
)

Expand Down
Loading