diff --git a/.github/workflows/dependencies.yml b/.github/workflows/dependencies.yml new file mode 100644 index 000000000..aa759850c --- /dev/null +++ b/.github/workflows/dependencies.yml @@ -0,0 +1,63 @@ + +# This workflow is borrowed from reth: https://github.com/paradigmxyz/reth/blob/e04292247fff14ea93b4b0f6cf427bc9e4365c75/.github/workflows/dependencies.yml +# Automatically run `cargo update` periodically + +name: Update Dependencies + +on: + schedule: + # Run weekly + - cron: "0 0 * * SUN" + workflow_dispatch: + # Needed so we can run it manually + +env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: cargo-update + TITLE: "chore(deps): weekly `cargo update`" + BODY: | + Automation to keep dependencies in `Cargo.lock` current. + +
cargo update log +

+ + ```log + $cargo_update_log + ``` + +

+
+ +jobs: + update: + name: Update + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: dtolnay/rust-toolchain@stable + + - name: cargo update + # Remove first line that always just says "Updating crates.io index" + run: cargo update --color never 2>&1 | sed '/crates.io index/d' | tee -a cargo_update.log + + - name: craft commit message and PR body + id: msg + run: | + export cargo_update_log="$(cat cargo_update.log)" + + echo "commit_message<> $GITHUB_OUTPUT + printf "$TITLE\n\n$cargo_update_log\n" >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + echo "body<> $GITHUB_OUTPUT + echo "$BODY" | envsubst >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v5 + with: + add-paths: ./Cargo.lock + commit-message: ${{ steps.msg.outputs.commit_message }} + title: ${{ env.TITLE }} + body: ${{ steps.msg.outputs.body }} + branch: ${{ env.BRANCH }} diff --git a/book/src/developers/contributing/rotation/index.md b/book/src/developers/contributing/rotation/index.md index 3d9058120..218856784 100644 --- a/book/src/developers/contributing/rotation/index.md +++ b/book/src/developers/contributing/rotation/index.md @@ -48,10 +48,6 @@ When you get to the end of your checklist, here are ideas for what to work on ne - Respond to [Github Participating Notifications](https://github.com/notifications?query=reason%3Aparticipating) - Review PRs that have been stuck for >24 hours - Find a [Flamingo Issue](https://github.com/ethereum/trin/issues?q=is%3Aopen+is%3Aissue+label%3Aflamingo) that seems promising, and assign it to yourself (and the project dashbord) -- Run `cargo outdated` - - Pick one or several libraries to upgrade - - Post a PR with the new `Cargo.lock` - - If `cargo outdated` shows all libraries as up-to-date, try `cargo outdated --aggressive` - grep code for `TODO`s. For each one you find: - write up issue to explain what needs to be done, and a plan - link to the TODO in the code, and any relevant context