Skip to content

Commit

Permalink
chore: update docs, readme, and update templates, workflows
Browse files Browse the repository at this point in the history
chore: resolves failed workflow errors
* Changes cargo doc test to only zk crates
* Updates to make use of faster runner
* Run clippy
  • Loading branch information
dutterbutter committed Oct 27, 2023
1 parent 0290631 commit 33feb62
Show file tree
Hide file tree
Showing 39 changed files with 675 additions and 948 deletions.
7 changes: 2 additions & 5 deletions .github/ISSUE_TEMPLATE/BUG-FORM.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,8 @@ body:
description: What component is the bug in?
multiple: true
options:
- Forge
- Cast
- Anvil
- Foundryup
- Chisel
- zkForge
- zkCast
- Other (please describe)
validations:
required: true
Expand Down
7 changes: 2 additions & 5 deletions .github/ISSUE_TEMPLATE/FEATURE-FORM.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,8 @@ body:
description: What component is the feature for?
multiple: true
options:
- Forge
- Cast
- Anvil
- Foundryup
- Chisel
- zkForge
- zkCast
- Other (please describe)
validations:
required: true
Expand Down
30 changes: 13 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
<!--
Thank you for your Pull Request. Please provide a description above and review
the requirements below.
# What :computer:
* First thing updated with this PR
* Second thing updated with this PR
* Third thing updated with this PR

Bug fixes and new features should include tests.
-->
# Why :hand:
* Reason why first thing was added to PR
* Reason why second thing was added to PR
* Reason why third thing was added to PR

## Motivation
# Evidence :camera:
Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended

<!--
Explain the context and why you're making that change. What is the problem
you're trying to solve? In some cases there is not a problem and this can be
thought of as being the motivation for your change.
-->
<!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. -->

## Solution

<!--
Summarize the solution and provide any necessary context needed to understand
the code change.
-->
<!-- # Notes :memo:
* Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
18 changes: 18 additions & 0 deletions .github/workflows/check-pr-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Check PR title
on:
pull_request_target:
types:
- opened
- reopened
- edited
- synchronize

jobs:
lint:
runs-on: ubuntu-latest
permissions:
statuses: write
steps:
- uses: aslafy-z/conventional-pr-title-action@v3
env:
GITHUB_TOKEN: ${{ github.token }}
4 changes: 2 additions & 2 deletions .github/workflows/deny.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ name: deny

on:
push:
branches: [master]
branches: [main]
paths: [Cargo.lock, deny.toml]
pull_request:
branches: [master]
branches: [main]
paths: [Cargo.lock, deny.toml]

env:
Expand Down
96 changes: 0 additions & 96 deletions .github/workflows/docker-publish.yml

This file was deleted.

58 changes: 0 additions & 58 deletions .github/workflows/heavy-integration.yml

This file was deleted.

16 changes: 0 additions & 16 deletions .github/workflows/project.yml

This file was deleted.

6 changes: 1 addition & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

release-docker:
name: Release Docker
uses: ./.github/workflows/docker-publish.yml

release:
name: ${{ matrix.job.target }} (${{ matrix.job.os }})
runs-on: ${{ matrix.job.os }}
Expand Down Expand Up @@ -232,7 +228,7 @@ jobs:
issue:
name: Open an issue
runs-on: ubuntu-latest
needs: [prepare, release-docker, release, cleanup]
needs: [prepare, release, cleanup]
if: ${{ failure() }}
steps:
- uses: actions/checkout@v3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: TruffleHog OSS
Expand Down
Loading

0 comments on commit 33feb62

Please sign in to comment.