generated from RebeccaStevens/template-typescript-node-package
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from RebeccaStevens/uom-types
feat: increase the exponent range to +-12 feat: add predefined units feat: add conversion functions build: cleanup build process BREAKING CHANGE: Extra details of a unit, such as its scalar factor, are now stored as part of the unit's meta, not on a subcomponent of the unit. BREAKING CHANGE: "si-units" submodule removed. It has been replaced by "units".
- Loading branch information
1 parent
5d81095
commit d6f0c76
Showing
221 changed files
with
11,202 additions
and
1,889 deletions.
There are no files selected for viewing
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
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 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 |
---|---|---|
@@ -0,0 +1,86 @@ | ||
name: Release Docs | ||
|
||
on: | ||
workflow_dispatch: | ||
workflow_call: | ||
|
||
permissions: | ||
contents: write | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: Release Docs | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
get_old_docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: get the gh-pages repo | ||
uses: actions/checkout@v3 | ||
with: | ||
ref: gh-pages | ||
continue-on-error: true | ||
|
||
- name: tar the existing docs | ||
run: | | ||
mkdir -p ./docs/generated | ||
tar -cvf old-docs.tar ./docs/generated | ||
- name: create a document artifact | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: old-docs | ||
path: old-docs.tar | ||
|
||
update_and_deploy_docs: | ||
needs: get_old_docs | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout src | ||
uses: actions/checkout@v3 | ||
|
||
- uses: ./.github/actions/prepare | ||
|
||
- run: mkdir -p ./docs/generated | ||
- name: Download the existing documents artifact | ||
uses: actions/download-artifact@v3 | ||
with: | ||
name: old-docs | ||
|
||
- run: tar -xf old-docs.tar ./docs/generated -C ./docs/generated | ||
|
||
- name: Build docs | ||
run: pnpm run docs | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
path: ./docs/generated | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 | ||
|
||
- run: 'echo "PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: ''{ print $2 }'' | sed ''s/[", ]//g'')" >> $GITHUB_ENV' | ||
- name: Update Coverage Badge | ||
run: cp ./docs/generated/v$PACKAGE_VERSION/coverage.svg ./docs/coverage.svg | ||
|
||
- id: coverage_changed | ||
run: echo "coverage_changed=$(git status --porcelain -u | grep -c docs/coverage.svg)" >> "$GITHUB_OUTPUT" | ||
|
||
- id: push_coverage | ||
env: | ||
COVERAGE_CHANGED: ${{ steps.coverage_changed.outputs.coverage_changed }} | ||
UP_TO_DATE: ${{ github.ref == 'refs/heads/main' }} | ||
run: echo "push_coverage=$(if [[ "$COVERAGE_CHANGED" != '0' && "$UP_TO_DATE" == "true" ]] ; then echo '1' ; else echo '0' ; fi)" >> "$GITHUB_OUTPUT" | ||
|
||
- if: steps.push_coverage.outputs.push_coverage != '0' | ||
run: | | ||
git add docs/coverage.svg | ||
git commit -m "docs: updated documentation coverage" | ||
git push |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,15 @@ | ||
node_modules/ | ||
|
||
/.type-coverage/ | ||
/coverage/ | ||
/coverage-ts/ | ||
/dist/ | ||
|
||
*.log | ||
|
||
# Autogen files | ||
/docs/generated/ | ||
/docs/coverage.svg | ||
/src/exponents.ts | ||
/src/units/converters/prefixes.ts | ||
/src/units/modifiers/prefixes.ts |
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 |
---|---|---|
@@ -1,4 +1,13 @@ | ||
/CHANGELOG.md | ||
/coverage | ||
/.type-coverage/ | ||
/coverage/ | ||
/coverage-ts/ | ||
/dist/ | ||
/pnpm-lock.yaml | ||
|
||
# Autogen files | ||
/docs/generated/ | ||
/docs/coverage.svg | ||
/src/exponents.ts | ||
/src/units/converters/prefixes.ts | ||
/src/units/modifiers/prefixes.ts |
Oops, something went wrong.