refactor: updated action example on readme #51
Conversation
BES-85 Proofread the README
Make sure there is no typos in the readme and the grammar is correct.s Then add a usage example showing how to configure export with a matrix of arguments, this can be seen in the testing repo. |
| @@ -4,18 +4,17 @@ | |||
|
|
|||
| # Interface Exporter Action | |||
|
|
|||
| Interface Exporter Action automates the process of extracting TypeScript interfaces from Solidity contracts and provides compatibility with TypeChain. Developers can seamlessly generate typings with only a few lines of yaml code. | |||
| Interface Exporter Action automates the process of extracting TypeScript interfaces from Solidity contracts and interfaces and provides compatibility with TypeChain. Developers can seamlessly generate typings with only a few lines of yaml code. | |||
There was a problem hiding this comment.
If we decide to call the action Solidity Exporter Action this paragraph needs to be changed
README.md
Outdated
| | package_name | Chosen name for the exported NPM package | **Required** | | | ||
| | out | The path to the directory where contracts are built | out | | | ||
| | interfaces | The path to the directory where the interfaces are located | src/interfaces | | | ||
| | contracts | The path to the directory where the contracts are located | src/contracts | | | ||
| | export_type | Export option which NPM package will be compatible | interfaces | interfaces, contracts | |
There was a problem hiding this comment.
Let's sync the descriptions with what we have in the action.yml 🙏🏻
README.md
Outdated
| - name: Export Interfaces - ${{ matrix.export_type }} | ||
| uses: defi-wonderland/interface-exporter-action@v1 | ||
| with: | ||
| package_name: '@defi-wonderland/interfaces-exporter-action-test-${{ matrix.export_type }}' |
There was a problem hiding this comment.
Someone may be confused by the name of the package here, e.g. maybe it has to have interfaces-exporter in it. Let's make it obviously fake.
| package_name: '@defi-wonderland/interfaces-exporter-action-test-${{ matrix.export_type }}' | |
| package_name: 'your-project-${{ matrix.export_type }}' |
README.md
Outdated
| export_type: '${{ matrix.export_type }}' | ||
|
|
||
| - name: Publish | ||
| run: cd export/@defi-wonderland/interfaces-exporter-action-test-${{ matrix.export_type }} && npm publish --access public |
There was a problem hiding this comment.
| run: cd export/@defi-wonderland/interfaces-exporter-action-test-${{ matrix.export_type }} && npm publish --access public | |
| run: cd export/your-project-${{ matrix.export_type }} && npm publish --access public |
README.md
Outdated
| run: yarn version --new-version "0.0.0-${GITHUB_SHA::8}" --no-git-tag-version | ||
|
|
||
| - name: Export Solidity - ${{ matrix.export_type }} | ||
| uses: defi-wonderland/interface-exporter-action@latest |
There was a problem hiding this comment.
Is it ok to use @latest?
There was a problem hiding this comment.
@0xDiscotech I believe it will work only if we tag a release as latest. Not sure tbh, better specify @v1 or something like that. Also as a user, I'd prefer setting a known version to avoid the action stealing the NPM token or rugging me in a way, which is possible if you're always pulling the latest version.
There was a problem hiding this comment.
Good to know! Will use @v1 so
Updated README based on changes done on this PR: #50
CLOSES BES-85