Skip to content

fix: docs spelling issues #335

fix: docs spelling issues

fix: docs spelling issues #335

Workflow file for this run

on:
push:
branches:
- 'main'
tags:
- 'bens/v*'
paths:
- blockscout-ens/**
- .github/workflows/bens.yml
- .github/actions/deps/**
pull_request:
paths:
- blockscout-ens/**
- .github/workflows/bens.yml
- .github/actions/deps/**
name: Test, lint and docker (bens)
env:
REGISTRY: ghcr.io
IMAGE_NAME: blockscout/bens
defaults:
run:
working-directory: blockscout-ens
jobs:
test:
name: Unit, doc and integration tests
runs-on: ubuntu-latest
services:
postgres:
image: postgres:16
env:
POSTGRES_PASSWORD: admin
POSTGRES_USER: graph-node
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432
steps:
- name: Checkout sources
uses: actions/checkout@v4
- name: Install deps
uses: ./.github/actions/deps
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal
override: true
- name: Rust cache
uses: Swatinem/rust-cache@v2
with:
cache-on-failure: true
workspaces: blockscout-ens -> target
- name: Unit tests
run: cargo test --locked --workspace --all-features --lib --bins -- --nocapture
if: success() || failure()
env:
RUST_BACKTRACE: 1
RUST_LOG: info
DATABASE_URL: postgres://graph-node:admin@localhost:5432/
SQLX_OFFLINE: true
- name: Integration tests
run: cargo test --locked --workspace --test '*' -- --nocapture --include-ignored
if: success() || failure()
env:
RUST_BACKTRACE: 1
RUST_LOG: info
DATABASE_URL: postgres://graph-node:admin@localhost:5432/
SQLX_OFFLINE: true
lint:
name: Linting
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
- name: Install deps
uses: ./.github/actions/deps
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal
components: rustfmt, clippy
override: true
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: true
workspaces: blockscout-ens -> target
- name: cargo fmt
run: cargo fmt --all -- --check --config imports_granularity=Crate
- name: cargo clippy
run: cargo clippy --all --all-targets --all-features -- -D warnings
push:
name: Docker build and docker push
needs:
- test
- lint
if: |
always() &&
(needs.test.result == 'success' || needs.test.result == 'cancelled') &&
(needs.lint.result == 'success' || needs.lint.result == 'cancelled')
timeout-minutes: 60
runs-on: ubuntu-latest
outputs:
semver: ${{ steps.regex.outputs.group2 }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
- uses: actions-ecosystem/action-regex-match@v2
id: regex
with:
text: ${{ github.ref }}
regex: '^(refs\/tags\/bens\/(v\d+\.\d+\.\d+))|(refs\/heads\/(main))$'
- name: Extract tag name
id: tags_extractor
run: |
t=${{ steps.regex.outputs.group2 }}
m=${{ steps.regex.outputs.group4 }}
(if ! [[ "$t" == "" ]]; then echo tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:$t, ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest; elif ! [[ "$m" == "" ]]; then echo tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:$m; else echo tags=; fi) >> $GITHUB_OUTPUT
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata for Docker
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Build and push
uses: docker/build-push-action@v5
with:
context: "blockscout-ens"
file: "blockscout-ens/Dockerfile"
build-contexts: |
proto=proto
push: ${{ steps.tags_extractor.outputs.tags != '' }}
tags: ${{ steps.tags_extractor.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=registry,ref=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:build-cache
cache-to: ${{ github.ref == 'refs/heads/main' && format('type=registry,ref={0}/{1}:build-cache,mode=max', env.REGISTRY, env.IMAGE_NAME) || '' }}
publish_types_package:
name: Publish types package
uses: './.github/workflows/npm-publisher.yml'
needs: push
if: needs.push.outputs.semver != ''
secrets: inherit
with:
version: ${{ needs.push.outputs.semver }}
project_name: blockscout-ens
push-swagger:
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags'))
uses: ./.github/workflows/_push_swagger.yml
with:
service_name: 'bens'
swagger_path: 'blockscout-ens/bens-proto/swagger/bens.swagger.yaml'
secrets:
api_token_github: ${{ secrets.BLOCKSCOUT_BOT_TOKEN }}