-
Notifications
You must be signed in to change notification settings - Fork 18
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
feat(devx): Generate and upload references by network for documentation #4554
base: develop
Are you sure you want to change the base?
Conversation
Modify output dir for generated rust docs Modify output dir for generated graphql docs Fix entry points for ts docs and updated output dir Removed rust, graphql and ts doc generation from build and start in docs Added generate-ts-docs and generate-graphql-docs to docs' package.json
added step that calls the download-iota-refs script
Didn't work for me so I pushed a fix. {
"ref": "develop"
} and running: act -W ./.github/workflows/upload-docs-to-aws.yml -e event.json |
Added download step to dev and build actions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
Tested with
act -W ./.github/workflows/upload-docs-to-aws.yml -P ubuntu-latest=catthehacker/ubuntu:full-20.04 -e event.json --secret-file <(aws --profile iota-wiki configure export-credentials --format env)
where my credentials are stored in the iota-wiki
profile. I also specified a s3 bucket obviously. And I had to use GitHub.ref
instead of GitHub.ref_name
but that seems to be an act bug 😢. Also I skipped the rust install step as the full images comes with rust pre installed.
Just one small fix, the folder name is incorrect. I will push a fix
|
||
# ----------- Build Rust Docs ----------- | ||
- name: Install Rust stable | ||
uses: dtolnay/rust-toolchain@stable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this use the rust version in rust-toolchain.toml
instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tbh, I'm not that familiar with GH workflows, but if you can suggest how to retrieve it, I'd be happy to add it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can only hardcode it 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to check how the others in the repo tho it but then remembered that we use self hosted everywhere which has rust pre-installed 😆
080fce3
to
0da82c4
Compare
Description of change
Updated the docs' workflow to upload the generated APIs for the
testnet
anddevnet
branches to an AWS bucket, which can then be downloaded by the docs.Links to any relevant issues
fixes #1432
fixes #4097
Type of change
How the change has been tested
This branch uses said documentation.
Change checklist
Tick the boxes that are relevant to your changes, and delete any items that are not.