Skip to content
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

docs: add quickstart guides for warden and initia #770

Merged
merged 6 commits into from
Sep 26, 2024

Conversation

technicallyty
Copy link
Contributor

  • adds quickstart guides for warden and initia
  • changes language around required version. we don't want people using versions above the specified anymore, since v2 has some breaking changes.

This comment has been minimized.

@technicallyty

This comment has been minimized.

Copy link

⌛ check-spelling changes applied

As configured, the commit pushed by @check-spelling-bot to GitHub doesn't trigger GitHub workflows due to a limitation of the @github-actions system.

Users with the Admin role can address this for future interactions 🪄

Create a deploy key and secret

(
  set -e
  brand=check-spelling; repo='skip-mev/connect'; SECRET_NAME=CHECK_SPELLING
  cd "$(mktemp -d)"
  ssh-keygen -f "./$brand" -q -N "" -C "$brand key for $repo"
  gh repo deploy-key add "./$brand.pub" -R "$repo" -w -t "$brand-talk-to-bot"
  gh secret -R "$repo" set "$SECRET_NAME" < "./$brand"
)

Configure update job in workflow to use secret

If the .github/workflows/spell.yml workflow Spell checking job doesn't already have the check-spelling/with/ssh_key, then add them:

    name: Spell checking
    ...
    steps:
    ...
    - name: apply spelling updates
      uses: ${action_ref:-check-spelling/check-spelling@...}
      with:
        checkout: true
+       ssh_key: "${{ secrets.CHECK_SPELLING }}"

To trigger another validation round and hopefully a ✅, please add a blank line, e.g. to .github/actions/spelling/expect.txt and commit the change.

Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.97%. Comparing base (b11a57b) to head (3ebea63).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #770      +/-   ##
==========================================
- Coverage   57.01%   56.97%   -0.04%     
==========================================
  Files         208      208              
  Lines       11626    11626              
==========================================
- Hits         6628     6624       -4     
- Misses       4394     4398       +4     
  Partials      604      604              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@technicallyty technicallyty merged commit ee8fe93 into main Sep 26, 2024
12 of 13 checks passed
@technicallyty technicallyty deleted the tyler/quickstarts branch September 26, 2024 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants