Skip to content

Commit

Permalink
ci: update the docs as part of the release
Browse files Browse the repository at this point in the history
remove extra logic that was need for typedoc-plugin-versions

re #580
  • Loading branch information
RebeccaStevens committed Nov 26, 2024
1 parent d718d3d commit 2280283
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 201 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/docs/generated/** linguist-generated
71 changes: 0 additions & 71 deletions .github/workflows/docs-release.yml

This file was deleted.

70 changes: 0 additions & 70 deletions .github/workflows/docs-update.yml

This file was deleted.

42 changes: 0 additions & 42 deletions .github/workflows/gh-pages-sync-workflows.yml

This file was deleted.

12 changes: 12 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ jobs:
with:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

- if: steps.should_release.outputs.should_release != '0'
name: Generate Docs
run: pnpm run docs

- continue-on-error: true
if: steps.should_release.outputs.should_release != '0'
name: Commit
run: |
git add -f docs/generated
git commit -m "docs: update documentation"
git push
name: Release

on:
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
coverage/
docs/generated/
lib/
node_modules/
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<!-- prettier-ignore-end -->
<a href="https://github.com/JoshuaKGoldberg/ts-api-utils/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
<a href="https://codecov.io/gh/JoshuaKGoldberg/ts-api-utils" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/ts-api-utils?label=%F0%9F%A7%AA%20coverage" /></a>
<a href="#" target="_blank"><img alt="📚 Documentation Coverage" src="https://raw.githubusercontent.com/JoshuaKGoldberg/ts-api-utils/refs/heads/main/docs/generated/coverage.svg" /></a>
<a href="https://github.com/JoshuaKGoldberg/ts-api-utils/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
<a href="http://npmjs.com/package/ts-api-utils"><img alt="📦 npm version" src="https://img.shields.io/npm/v/ts-api-utils?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
Expand Down
17 changes: 0 additions & 17 deletions docs/coverage.svg

This file was deleted.

0 comments on commit 2280283

Please sign in to comment.