Skip to content

feat: automate the release process via CHANGELOG.md #473

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

feat: automate the release process via CHANGELOG.md #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9df708c
feat: automate the release process via CHANGELOG.md
galargh Jul 16, 2024
04c15d6
chore: update .github/workflows/release.yml
galargh Jul 16, 2024
3a3603f
docs: update README.md
galargh Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Release
on:
push:
paths: [CHANGELOG.md]
branches: [master]
pull_request:
paths: [CHANGELOG.md]
branches: [master]
jobs:
release:
name: Release
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- uses: actions/checkout@v4
- id: release
uses: ipdxco/changelog-driven-release@v1
with:
path: CHANGELOG.md
draft: ${{ github.event_name == 'pull_request' }}
mutable: 'false'
- if: github.event_name == 'pull_request' && steps.release.outputs.tag != ''
uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 # v2.9.0
with:
header: release
recreate: true
message: |
## [${{ steps.release.outputs.tag }}](${{ steps.release.outputs.url }})

${{ steps.release.outputs.body }}
106 changes: 94 additions & 12 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,84 @@
# filecoin-ffi changelog
# Changelog
All notable changes to this project will be documented in this file.

## 0.30.3
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

## [1.28.0-rc2] - 2024-06-27

## [1.28.0-rc1] - 2024-06-18

## [1.28.0-dev2] - 2024-06-14

## [1.28.0-dev] - 2024-05-02

## [1.27.0-rc2] - 2024-04-29

## [1.27.0-rc1] - 2024-04-10

## [1.26.0-rc2] - 2024-01-31

## [1.26.0] - 2024-01-31

## [1.26.0-rc1] - 2024-01-25

## [1.25.1-dev.0] - 2023-11-20

## [1.24.0-rc.2] - 2023-10-04

## [1.25.0-dev.2] - 2023-10-04

## [1.24.0-rc.1] - 2023-10-03

## [1.24.0-dev.2] - 2023-09-23

## [1.23.4-pre1] - 2023-09-05

## [1.25.0-dev.1] - 2023-08-28

## [1.25.0-dev.0] - 2023-08-23

## [1.24.0-dev.0] - 2023-08-22

## [1.23.3-randomness] - 2023-08-21

## [1.24.0] - 2023-07-31

## [1.23.3-pre1] - 2023-06-29

## [1.23.1-pre1] - 2023-04-28

## [1.23.0] - 2023-04-23

## [1.22.1] - 2023-04-23

## [1.22.0-rc3] - 2023-04-19

## [1.22.0] - 2023-04-19

## [1.23.0-rc1] - 2023-04-19

## [1.22.0-rc2] - 2023-04-19

## [1.22.0-rc1] - 2023-04-10

## [1.22.0-pre1] - 2023-04-05

## [1.20.0-concurrency-fix] - 2023-03-14

## [1.21.0-rc.2] - 2023-03-14

## [1.21.0-rc.1] - 2023-03-09

## [1.21.0-alpha.1] - 2023-03-01

## [1.20.0] - 2023-02-27

## [1.20.0-rc1] - 2023-02-10

## [0.30.3] - 2020-02-07

This release adds `FauxRep` to the `ffi` package, and a few other
rust-fil-proofs improvements, which you can read about [here](https://github.com/filecoin-project/rust-fil-proofs/blob/master/CHANGELOG.md#403---2020-07-01).
Expand All @@ -16,7 +94,7 @@ rust-fil-proofs improvements, which you can read about [here](https://github.com
|-------------|---------|---------|---------------|
| Erin Swenson-Healey | 1 | +370/-143 | 9 |

## 0.30.2
## [0.30.2] - 2020-29-06

This release fixed a bug in the `ffi.Aggregate` function, which did not properly
handle a NUL byte (representing an error) returned from the `fil_aggregate` Rust
Expand All @@ -34,7 +112,7 @@ function.
|-------------|---------|---------|---------------|
| Erin Swenson-Healey | 2 | +45/-1 | 3 |

## 0.30.1
## [0.30.1] - 2020-26-06

This release wil include Window PoSt speedups (2x measured for 32GiB sectors),
RAM reduction of 56GiB for 32GiB sectors (mmap'd parent cache with windows for
Expand All @@ -59,7 +137,7 @@ updates (for the trusted setup participants).
| Erin Swenson-Healey | 2 | +90/-68 | 7 |
| laser | 1 | +31/-0 | 1 |

## 0.30.0
## [0.30.0] - 2020-15-06

This release includes an update specs-actors (splits abi.RegisteredProof into
two new types - one for seal and one for PoSt) and an update to rust-fil-proofs
Expand Down Expand Up @@ -90,7 +168,7 @@ two new types - one for seal and one for PoSt) and an update to rust-fil-proofs
| Henri | 1 | +2/-2 | 1 |


## 0.29.0
## [0.29.0] - 2020-08-06

Big changes here! We moved off of the nightly Rust channel, fixed a nasty file
descriptor-leak, and (most importantly) updated to [v27 parameters and keys](https://github.com/filecoin-project/rust-fil-proofs/blob/master/CHANGELOG.md#300---2020-06-08).
Expand All @@ -111,7 +189,7 @@ descriptor-leak, and (most importantly) updated to [v27 parameters and keys](htt
| Volker Mische | 1 | +1/-3 | 3 |


## 0.28.1
## [0.28.1] - 2020-04-06

This release modifies the rust-filecoin-proofs-api dependency, downloading it
from crates.io instead of GitHub. No behavior changes.
Expand All @@ -128,7 +206,7 @@ from crates.io instead of GitHub. No behavior changes.
| nemo | 1 | +6/-5 | 3 |


## 0.28.0
## [0.28.0] - 2020-03-06

This release adds unseal-to-a-file-descriptor functionality to the API, improves
merkle tree cache usage, [and more](https://github.com/filecoin-project/rust-fil-proofs/blob/master/CHANGELOG.md#200---2020-05-27).
Expand All @@ -146,7 +224,7 @@ merkle tree cache usage, [and more](https://github.com/filecoin-project/rust-fil
| Erin Swenson-Healey | 2 | +245/-371 | 9 |


## 0.27.0
## [0.27.0] - 2020-21-05

This release migrates from specs-actors 0.4.1 to 0.5.4.

Expand Down Expand Up @@ -194,7 +272,7 @@ This release migrates from specs-actors 0.4.1 to 0.5.4.
| Frrist | 2 | +27/-8 | 2 |
| cerasusland | 1 | +2/-5 | 1 |

## 0.26.2
## [0.26.2] - 2020-19-05

This release contains a fix for a bug which prevented unmodified miners from
generating Winning PoSts for 64GiB sectors. It also contains a fix for a bug
Expand All @@ -217,7 +295,7 @@ the CGO call returned).
| laser | 1 | +5/-5 | 1 |
| shannon-6block | 1 | +2/-0 | 1 |

## 0.26.1
## [0.26.1] - 2020-15-05

This release updates to version 0.4.1 of specs-actors, which (among other
things) extends the `RegisteredProof` types to include 64GiB sector sizes. It
Expand Down Expand Up @@ -272,7 +350,7 @@ a single byte array) and various fixes for bellperson and neptune Rust crates.
| ZX | 1 | +48/-20 | 5 |
| nemo | 1 | +4/-56 | 2 |

## 0.26.0
## [0.26.0] - 2020-05-08

This release migrates from v25 to v26 Groth parameters, which allows us to use
64GiB sectors. It also adds some safety to the CGO bindings, which were
Expand All @@ -290,3 +368,7 @@ previously sharing Go memory with C, resulting in some errors when running with
| Contributor | Commits | Lines ± | Files Changed |
|-------------|---------|---------|---------------|
| Erin Swenson-Healey | 2 | +514/-375 | 15 |

## [0.25.1] - 2020-04-27

## [0.0.1] - 2020-01-14
36 changes: 3 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Run it like so:
./mkreleaselog v0.25.0 v0.26.0 > /tmp/v0.26.0.notes.txt
```

## Contribution
## Contribution

### Maintainers

Expand Down Expand Up @@ -124,7 +124,7 @@ We will cooperates with the [lotus' releases and it's testing flows](https://git
- If any bug is found during the testing, the fix should land in master then get backported to `release/lotus-vX`. The updated commit should be integrated into lotus and getting tested. Repeat the steps until it can be considered as stable.

*Consensus breaking changes*
- Consensus breaking changes should be developed in it's own branch, (branch name is suggested to be: feature branches `feat/` or bug fix branches `bug/`).
- Consensus breaking changes should be developed in it's own branch, (branch name is suggested to be: feature branches `feat/` or bug fix branches `bug/`).
- Consensus breaking changes that are scoped into the next immediate network upgrade shall land in `next` branch first. The maintainers are responsible to coordinate on when to land `next` to `master` according to lotus mandatory(network upgrade) release schedules.
- A new dev branch should be created and contributors are responsible to rebase the branch onto `master`/`next` as needed.

Expand All @@ -134,37 +134,7 @@ The versioning in Filecoin-FFI currently follows the Lotus versioning. For exam

#### Release Process
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also have a note about if/how/when release assets are created (since I don't think that is covered in #464 )


##### Cutting a development or release candidate release

<details>
<summary>Steps to cut a development or release candidate release:</summary>

1. Go to [Filecoin-FFI Releases](https://github.com/filecoin-project/filecoin-ffi/releases).
2. Click the "Draft a new release" button in the right corner.
3. In the "Choose a tag" dropdown, enter the desired version and click "Create new tag: vX.XX.X-rcX/dev on publish".
4. Target the master branch.
5. Set the previous tag to compare against, which should be the last stable release.
6. Click the "Generate release notes" button.
6. Check the "Set as a pre-release" checkbox.
7. Click "Publish release" to create the release.

</details>

##### Cutting a definitive release

<details>
<summary>Steps to cut a definitive release:</summary>

1. Go to [Filecoin-FFI Releases](https://github.com/filecoin-project/filecoin-ffi/releases).
2. Click the "Draft a new release" button in the right corner.
3. In the "Choose a tag" dropdown, enter the desired version and click "Create new tag: vX.XX.X on publish".
4. Target the release candidate you want to create a stable.
5. Set the previous tag to compare against, which should be the last stable release (e.g., non-RC)
6. click the "Generate release notes" button.
6. Ensure the "Set as a latest release" checkbox **is checked**.
7. Click "Publish release" to create the release.

</details>
Create a new entry in the [Changelog](CHANGELOG.md) for the new release. If you don't provide any description/body for the new entry, the release will be created with auto-generated release notes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Create a new entry in the [Changelog](CHANGELOG.md) for the new release. If you don't provide any description/body for the new entry, the release will be created with auto-generated release notes.
Create a new entry in the [Changelog](CHANGELOG.md) via PR for the new release using the [keep a changelog format](https://keepachangelog.com/en/1.1.0/).
When the PR is opened, a draft GitHub release will be created.
When the PR is merged, the GitHub release will be published.
If you don't provide any description/body for the new CHANGELOG entry, the release will be created with GitHub auto-generated release notes.
You can read more about this release flow at https://github.com/ipdxco/changelog-driven-release

Might just be me, but this section seemed a little too sparse. I know the process is simple (good), but I think a bit more info is useful.

https://keepachangelog.com/en/1.1.0/ doesn't seem like the right link here given it doesn't specify the ## [x.y.z] yyyy-mm-dd format I don't think. Maybe it would be better to link to https://github.com/ipdxco/changelog-driven-release?tab=readme-ov-file ?


## License

Expand Down
Loading