-
Notifications
You must be signed in to change notification settings - Fork 2
ci: add changelog and PR changelog check #9
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Runs changelog related jobs. | ||
| # CI job heavily inspired by: https://github.com/tarides/changelog-check-action | ||
|
|
||
| name: changelog | ||
|
|
||
| # Limits workflow concurrency to only the latest commit in the PR. | ||
| concurrency: | ||
| group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}" | ||
| cancel-in-progress: true | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, reopened, synchronize, labeled, unlabeled] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| changelog: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@main | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Check for changes in changelog | ||
| env: | ||
| BASE_REF: ${{ github.event.pull_request.base.ref }} | ||
| NO_CHANGELOG_LABEL: ${{ contains(github.event.pull_request.labels.*.name, 'no changelog') }} | ||
| run: ./scripts/check-changelog.sh | ||
| shell: bash |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ## 0.4.2 (TBD) | ||
|
|
||
| - [BREAKING] Removed `p3-miden-goldilocks` crate, now uses upstream `p3-goldilocks` (#3). | ||
| - Updated `Pcs` trait implementation for Plonky3 v0.4.2 compatibility (#3). | ||
| - Updated Plonky3 dependencies to v0.4.2 (#3). | ||
|
|
||
| ## 0.4.0 (2025-12-23) | ||
|
|
||
| - Initial release on crates.io containing Miden-specific Plonky3 crates. | ||
| - [BREAKING] Consolidated crates and removed duplicate symbolic modules to use base Plonky3 (#1). | ||
| - Added workspace release automation with dry-run and publish workflows. | ||
| - Migrated Plonky3 dependencies from git to crates.io v0.4.1 (#1). | ||
| - Added README documenting the five Miden-specific Plonky3 crates. | ||
| - Added dual MIT/Apache-2.0 license. | ||
| - Added CI workflows and Makefile for build automation. | ||
| - Fixed debug constraint checking to be gated behind `cfg(debug_assertions)`. | ||
|
|
||
| ### Crates included | ||
|
|
||
| - `p3-miden-air`: Miden-specific AIR abstractions. | ||
| - `p3-miden-fri`: Miden FRI implementation with hiding commitments. | ||
| - `p3-miden-prover`: Miden prover with constraint checking. | ||
| - `p3-miden-uni-stark`: Miden uni-STARK implementation. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| #!/bin/bash | ||
| set -uo pipefail | ||
|
|
||
| CHANGELOG_FILE="${1:-CHANGELOG.md}" | ||
|
|
||
| if [ "${NO_CHANGELOG_LABEL}" = "true" ]; then | ||
| # 'no changelog' set, so finish successfully | ||
| echo "\"no changelog\" label has been set" | ||
| exit 0 | ||
| else | ||
| # a changelog check is required | ||
| # fail if the diff is empty | ||
| if git diff --exit-code "origin/${BASE_REF}" -- "${CHANGELOG_FILE}"; then | ||
| >&2 echo "Changes should come with an entry in the \"CHANGELOG.md\" file. This behavior | ||
| can be overridden by using the \"no changelog\" label, which is used for changes | ||
| that are trivial / explicitly stated not to require a changelog entry." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "The \"CHANGELOG.md\" file has been updated." | ||
| fi |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is a breaking change, should we bump up to v0.5? On the other hand, it probably makes sense to keep in sync with P3 - and maybe we publish this one an yank v0.4.0 crates?
If we go with the second approach, we should make sure to release
miden-cryptov0.21.0 very soon after this release so that we don't breaknextofmiden-vmfor too long.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Second approach makes sense to me. /cc @Al-Kindi-0 @adr1anh
PR is 0xMiden/crypto#728 - with my recent edit, it's good to go right now.