feat: add @metamask/platform-api-docs package #8012
+7,698
−219
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,89 @@ | ||
| name: Deploy Platform API Docs | ||
|
|
||
| on: | ||
| workflow_call: | ||
|
|
||
| jobs: | ||
| build-docs: | ||
| name: Build Platform API docs | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - name: Checkout and setup environment | ||
| uses: MetaMask/action-checkout-and-setup@v3 | ||
| with: | ||
| is-high-risk-environment: true | ||
|
|
||
| - name: Generate and build Platform API docs | ||
| # The site is published under the `/platform-api/` subdirectory of | ||
| # the repo's GitHub Pages site so that other doc sites (e.g. | ||
| # package API docs) can be hosted alongside under sibling paths. | ||
| run: | | ||
| yarn docs:platform-api:build \ | ||
|
cryptodev-2s marked this conversation as resolved.
|
||
| --site-url "https://${{ github.repository_owner }}.github.io" \ | ||
| --site-base-url "/${{ github.event.repository.name }}/platform-api/" | ||
|
|
||
| - name: Upload build artifact | ||
| uses: actions/upload-artifact@v7 | ||
| with: | ||
| name: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' && 'platform-api-docs-build' || 'platform-api-docs' }} | ||
| path: .platform-api-docs/build/ | ||
| retention-days: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' && 1 || 7 }} | ||
|
|
||
| get-token: | ||
| name: Get access token | ||
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | ||
| needs: build-docs | ||
| runs-on: ubuntu-latest | ||
| environment: github-pages | ||
| permissions: | ||
| id-token: write | ||
| outputs: | ||
| token: ${{ steps.get-token.outputs.token }} | ||
| steps: | ||
| - name: Get access token | ||
| id: get-token | ||
| uses: MetaMask/github-tools/.github/actions/get-token@v1 | ||
| with: | ||
| token-exchange-url: ${{ vars.TOKEN_EXCHANGE_URL }} | ||
| permissions: | | ||
| contents: write | ||
|
|
||
| deploy: | ||
| name: Deploy to GitHub Pages | ||
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | ||
| needs: | ||
| - build-docs | ||
| - get-token | ||
| runs-on: ubuntu-latest | ||
| environment: github-pages | ||
| permissions: | ||
| # Just for the initial `actions/checkout` — the actual push to | ||
| # `gh-pages` uses the PAT from the `get-token` job, not GITHUB_TOKEN. | ||
| contents: read | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 1 | ||
|
|
||
| - name: Download build artifact | ||
| uses: actions/download-artifact@v8 | ||
| with: | ||
| name: platform-api-docs-build | ||
| path: build/ | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | ||
| with: | ||
| # Use a PAT obtained via Token Exchange Service rather than the | ||
| # default `GITHUB_TOKEN`. `GITHUB_TOKEN` can't be granted branch | ||
| # protections that disallow direct human pushes while still letting | ||
| # this workflow publish, which is what we want for `gh-pages`. | ||
| personal_token: ${{ needs.get-token.outputs.token }} | ||
| publish_dir: ./build | ||
| destination_dir: platform-api | ||
| # Preserve sibling subdirectories (e.g. /package-api/) so this | ||
| # deploy only overwrites /platform-api/. | ||
| keep_files: true | ||
|
cursor[bot] marked this conversation as resolved.
Comment on lines
+54
to
+89
Contributor
There was a problem hiding this comment. I don't understand why we need to do this, but I can take a closer look at this tomorrow to be sure.
Contributor
Author
There was a problem hiding this comment. Fixed in 7b7c7f2. Added |
||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,14 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
|
|
||
| - Initial release of the platform-api-docs package ([#8012](https://github.com/MetaMask/core/pull/8012)) | ||
|
|
||
| [Unreleased]: https://github.com/MetaMask/core/ |
|
mcmire marked this conversation as resolved.
|
This file contains hidden or 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,6 @@ | ||
| This project is licensed under either of | ||
|
|
||
| * MIT license ([LICENSE.MIT](LICENSE.MIT)) | ||
| * Apache License, Version 2.0 ([LICENSE.APACHE2](LICENSE.APACHE2)) | ||
|
|
||
| at your option. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.