chore: publish the Rust docs to Netlify #180
Conversation
collins-w
requested review from
d-carmo,
dylankilkenny,
nahimterrazas,
zeljkoX,
shahnami,
tirumerla and
LuisUrrutia
as code owners
…elin-relayer into rust-docs
.github/workflows/release-docs.yml
Outdated
| run: | | ||
| MAJOR_MINOR="${{ steps.validate_tag.outputs.MAJOR }}-${{ steps.validate_tag.outputs.MINOR }}" | ||
| echo "Major and minor version extracted: $MAJOR_MINOR" | ||
| sed -i '' -E "s|(https://)[^/]*openzeppelin-relayer\.netlify\.app|\1docs-v${MAJOR_MINOR}--openzeppelin-relayer.netlify.app|g" docs/modules/ROOT/nav.adoc |
There was a problem hiding this comment.
Lets make sure to change it to release-v* version on push to release branch and then on push to docs branch change it to docs-v*
.github/workflows/rc.yml
Outdated
| major_minor_version=$(echo "${{ steps.get_version.outputs.version }}" | cut -d'.' -f1,2) | ||
| echo "Major and minor version extracted: $major_minor_version" | ||
| sed -i '' -E "s|(https://)[^/]*openzeppelin-relayer\.netlify\.app|\1release-v${major_minor_version}--openzeppelin-relayer.netlify.app|g" docs/modules/ROOT/nav.adoc | ||
There was a problem hiding this comment.
Why not add this in "on push" to release-v* branch add condition to check if it's release branch version prefix url for netlify if not update it? This workflow we can keep just strictly to create a release branch
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #180 +/- ##
=======================================
+ Coverage 86.6% 87.2% +0.6%
=======================================
Files 126 131 +5
Lines 28000 29747 +1747
=======================================
+ Hits 24265 25969 +1704
- Misses 3735 3778 +43
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| id: get_branch | ||
| run: | | ||
| echo "branch=${{ inputs.branch }}" >> $GITHUB_OUTPUT | ||
| - name: Update the technical docs link in nav.adoc |
There was a problem hiding this comment.
Is it possible to use some kind of redirection instead of updating nav.adoc file every time?
There was a problem hiding this comment.
We will have different deployment url with every deploy?
There was a problem hiding this comment.
Yeah, each deploy will have a different prefix on the url(e.g release-v1, release-v2, docs-v1 etc)
There was a problem hiding this comment.
Can we do it without modifying file?
Maybe to always point to single url and in the background to redirect?
| @@ -1,6 +1,6 @@ | |||
| //! This module contains the status-related functionality for EVM transactions. | |||
| //! It includes methods for checking transaction status, determining when to resubmit | |||
| //! or replace transactions with NOOPs, and updating transaction status in the repository. | |||
| //! or replace transactions with NOPs, and updating transaction status in the repository. | |||
There was a problem hiding this comment.
typo, lets revert this one
| @@ -3,4 +3,4 @@ | |||
| * xref:api_reference.adoc[API Reference] | |||
| * xref:structure.adoc[Project Structure] | |||
| * xref:roadmap.adoc[Project Roadmap] | |||
| * link:https://openzeppelin-relayer.netlify.app/openzeppelin_relayer/[Technical Rust Documentation^] | |||
| * link:https://openzeppelin-relayer.netlify.app/openzeppelin_relayer/[Technical Rust Documentation] | |||
There was a problem hiding this comment.
Don't we want to open on a new tab?
There was a problem hiding this comment.
Opening in a new tab sounds good.
Summary
chore: publish rust docs to Netlify
Testing Process
Checklist