Skip to content

Commit

Permalink
ci: add a release pipeline (#440)
Browse files Browse the repository at this point in the history
  • Loading branch information
delehef committed Jan 25, 2025
1 parent 496636d commit a9e2b59
Show file tree
Hide file tree
Showing 17 changed files with 196 additions and 35 deletions.
9 changes: 9 additions & 0 deletions .github/changelog.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/sh
#
# This is a hack to palliate the fact that cargo-release runs the pre-release
# hook once for each crate, instead of only once for the whole workspace.
# Calling git-cliff multiple times with the same argument is idempotent, so we
# call it with settings generating the workspace-level changelog once for every
# crate.
git-cliff -o $WORKSPACE_ROOT/CHANGELOG.md --tag $NEW_VERSION -w $WORKSPACE_ROOT
echo $NEW_VERSION > $WORKSPACE_ROOT/VERSION
33 changes: 33 additions & 0 deletions .github/workflows/prepare-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Open a release PR
on:
workflow_dispatch:
inputs:
bump:
description: Release Level
required: true
type: choice
options:
- patch
- minor
- major

jobs:
make-release-pr:
permissions:
id-token: write
pull-requests: write
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: chainguard-dev/actions/setup-gitsign@main
- name: Install tooling
uses: taiki-e/install-action@v2
with:
tool: cargo-release,git-cliff
- uses: cargo-bins/release-pr@v2
with:
version: ${{ inputs.bump }}
github-token: ${{ secrets.GITHUB_TOKEN }}
# Keep all the crates versions in sync
crate-release-all: true
22 changes: 22 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Create Release

on:
push:
branches:
- main

jobs:
create-release:
runs-on: ubuntu-latest
if: startsWith( github.event.head_commit.message, 'release:' )
steps:
- uses: actions/checkout@v4
- name: Get version
id: set-tag
run: echo "tag=$(cat VERSION)" >> $GITHUB_OUTPUT
- uses: ncipollo/release-action@v1
with:
allowUpdates: true
omitBody: true
commit: "main"
tag: ${{ steps.set-tag.outputs.tag }}
Empty file added CHANGELOG.md
Empty file.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,7 @@ lto = "fat"
plonky2 = { git = "https://github.com/Lagrange-Labs/plonky2", branch = "upstream" }
plonky2_monolith = { git = "https://github.com/Lagrange-Labs/monolith" }
plonky2_field = { git = "https://github.com/Lagrange-Labs/plonky2", branch = "upstream" }

[workspace.metadata.release]
publish = false
pre-release-hook = ["sh", "../.github/changelog.sh"]
Empty file added VERSION
Empty file.
93 changes: 93 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[changelog]
# template for the changelog header
header = """
# Changelog\n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
{% endif %}\
{% if previous %}\
{% if previous.commit_id and commit_id %}
[{{ previous.commit_id | truncate(length=7, end="") }}]({{ previous.commit_id }})...\
[{{ commit_id | truncate(length=7, end="") }}]({{ commit_id }})
{% endif %}\
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{% for commit in commits | filter(attribute="scope") | sort(attribute="scope") %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\\
{% endfor %}
{% raw %}\n{% endraw %}\
{%- for commit in commits %}
- {{ commit.message | upper_first }}
{% endfor -%}
{% raw %}\n{% endraw %}\
{% endfor %}\n
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
]
# render body even when there are no releases to process
# render_always = true
# output file path
# output = "test.md"

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
# Replace issue numbers
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->Features" },
{ message = "^fix", group = "<!-- 1 -->Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->Documentation" },
{ message = "^perf", group = "<!-- 4 -->Performance" },
{ message = "^refactor", group = "<!-- 2 -->Refactor" },
{ message = "^style", group = "<!-- 5 -->Styling" },
{ message = "^test", group = "<!-- 6 -->Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^chore|^ci", group = "<!-- 7 -->Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->Security" },
{ message = "^revert", group = "<!-- 9 -->Revert" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
2 changes: 1 addition & 1 deletion gnark-utils/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "gnark-utils"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[build-dependencies]
Expand Down
12 changes: 6 additions & 6 deletions groth16-framework/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "groth16_framework"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand All @@ -14,16 +14,16 @@ revm.workspace = true
serde.workspace = true
serde_json.workspace = true

gnark-utils = { path = "../gnark-utils" }
mp2_common = { path = "../mp2-common" }
gnark-utils = { path = "../gnark-utils" , version = "1.1.3" }
mp2_common = { path = "../mp2-common" , version = "1.1.3" }

[dev-dependencies]
env_logger.workspace = true
itertools.workspace = true
rand.workspace = true
serial_test.workspace = true
sha2.workspace = true
mp2_test = { path = "../mp2-test" }
mp2_test = { path = "../mp2-test" , version = "1.1.3" }

recursion_framework = { path = "../recursion-framework" }
verifiable-db = { path = "../verifiable-db" }
recursion_framework = { path = "../recursion-framework" , version = "1.1.3" }
verifiable-db = { path = "../verifiable-db" , version = "1.1.3" }
6 changes: 3 additions & 3 deletions inspect/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "inspect"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand All @@ -14,5 +14,5 @@ serde.workspace = true
tabled.workspace = true
tokio.workspace = true

ryhope = { path = "../ryhope" }
mp2_v1 = { path = "../mp2-v1" }
ryhope = { path = "../ryhope" , version = "1.1.3" }
mp2_v1 = { path = "../mp2-v1" , version = "1.1.3" }
4 changes: 2 additions & 2 deletions mp2-common/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mp2_common"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand Down Expand Up @@ -33,7 +33,7 @@ rand.workspace = true
rstest.workspace = true
tokio.workspace = true

mp2_test = { path = "../mp2-test" }
mp2_test = { path = "../mp2-test" , version = "1.1.3" }

[features]
ci = ["mp2_test/ci"]
Expand Down
8 changes: 4 additions & 4 deletions mp2-test/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mp2_test"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand All @@ -14,9 +14,9 @@ plonky2_ecgfp5.workspace = true
rand.workspace = true
serde.workspace = true

mp2_common = { path = "../mp2-common" }
recursion_framework = { path = "../recursion-framework" }
ryhope = { path = "../ryhope" }
mp2_common = { path = "../mp2-common" , version = "1.1.3" }
recursion_framework = { path = "../recursion-framework" , version = "1.1.3" }
ryhope = { path = "../ryhope" , version = "1.1.3" }

[features]
ci = []
16 changes: 8 additions & 8 deletions mp2-v1/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mp2_v1" # TODO: fix the name to a meaningful one.
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand All @@ -27,11 +27,11 @@ serde_json.workspace = true
tokio-postgres.workspace = true
tracing.workspace = true

mp2_common = { path = "../mp2-common" }
recursion_framework = { path = "../recursion-framework" }
ryhope = { path = "../ryhope" }
parsil = { path = "../parsil" }
verifiable-db = { path = "../verifiable-db" }
mp2_common = { path = "../mp2-common" , version = "1.1.3" }
recursion_framework = { path = "../recursion-framework" , version = "1.1.3" }
ryhope = { path = "../ryhope" , version = "1.1.3" }
parsil = { path = "../parsil" , version = "1.1.3" }
verifiable-db = { path = "../verifiable-db" , version = "1.1.3" }

[dev-dependencies]
alloy.workspace = true
Expand All @@ -54,8 +54,8 @@ testfile.workspace = true
tokio-postgres.workspace = true
tokio.workspace = true

mp2_test = { path = "../mp2-test" }
parsil = { path = "../parsil" }
mp2_test = { path = "../mp2-test" , version = "1.1.3" }
parsil = { path = "../parsil" , version = "1.1.3" }

[features]
original_poseidon = ["mp2_common/original_poseidon"]
6 changes: 3 additions & 3 deletions parsil/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "parsil"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[lib]
Expand All @@ -24,8 +24,8 @@ sqlparser.workspace = true
stderrlog = { workspace = true, optional = true }
thiserror.workspace = true

ryhope = { path = "../ryhope" }
verifiable-db = { path = "../verifiable-db" }
ryhope = { path = "../ryhope" , version = "1.1.3" }
verifiable-db = { path = "../verifiable-db" , version = "1.1.3" }

[features]
cli = ["dep:stderrlog", "dep:clap"]
4 changes: 2 additions & 2 deletions recursion-framework/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "recursion_framework"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand All @@ -9,7 +9,7 @@ log.workspace = true
plonky2.workspace = true
serde.workspace = true

mp2_common = { path = "../mp2-common" }
mp2_common = { path = "../mp2-common" , version = "1.1.3" }

[dev-dependencies]
bincode.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion ryhope/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ryhope"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[lib]
Expand Down
10 changes: 5 additions & 5 deletions verifiable-db/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "verifiable-db"
version = "0.1.0"
version = "1.1.3"
edition = "2021"

[dependencies]
Expand All @@ -17,10 +17,10 @@ plonky2_ecgfp5.workspace = true
rand.workspace = true
serde.workspace = true

mp2_common = { path = "../mp2-common" }
recursion_framework = { path = "../recursion-framework" }
ryhope = { path = "../ryhope" }
mp2_test = { path = "../mp2-test" }
mp2_common = { path = "../mp2-common" , version = "1.1.3" }
recursion_framework = { path = "../recursion-framework" , version = "1.1.3" }
ryhope = { path = "../ryhope" , version = "1.1.3" }
mp2_test = { path = "../mp2-test" , version = "1.1.3" }

[dev-dependencies]
futures.workspace = true
Expand Down

0 comments on commit a9e2b59

Please sign in to comment.