Skip to content
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

chore(ci): Updated release please configuration #1787

Merged
merged 3 commits into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
13 changes: 13 additions & 0 deletions .github/workflows/release_please.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: release-please

# Trigger on merges to 'master' branch
on:
push:
branches:
Expand All @@ -15,11 +16,23 @@ jobs:
steps:
- uses: google-github-actions/release-please-action@v3
with:
# Our release type is simple as all we really want is to update the changelog and trigger a github release
release-type: simple
# Self explanatory
package-name: aztec-packages
# Marks github releases as 'Pre-Release'
prerelease: true
# Our default branch
default-branch: master
# Uses the 'prerelease' versioning strategy to update the pre-release number only e.g. 0.1.0-alpha23 -> 0.1.0-alpha24
versioning-strategy: prerelease
# Don't include the component name in the tag name
include-component-in-tag: false
# Influences the versioning strategy to only update the pre-release number
bump-minor-pre-major: true
# Influences the versioning strategy to only update the pre-release number
bump-patch-for-minor-pre-major: true
# Just a bit of test at the top of the 'Release PR'
pull-request-header: ":robot: I have created a new Aztec Packages release"
# The sections into which changes are grouped on the github release notes
changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":false},{"type":"test","section":"Miscellaneous","hidden":false},{"type":"refactor","section":"Miscellaneous","hidden":false},{"type":"docs","section":"Documentation","hidden":false}]'
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ All packages need to be included in the [build manifest](`build_manifest.json`),

Logging goes through the [`info` and `debug`](circuits/cpp/barretenberg/cpp/src/barretenberg/common/log.hpp) functions in C++, and through the [DebugLogger](yarn-project/foundation/src/log/debug.ts) module in Typescript. To see the log output, set a `DEBUG` environment variable to the name of the module you want to debug, to `aztec:*`, or to `*` to see all logs.

## Releases

Releases are driven by [release-please](https://github.com/googleapis/release-please), which maintains a 'Release PR' containing an updated CHANGELOG.md since the last release. Triggering a new release is simply a case of merging this PR to master. A [github workflow](./.github/workflows/release_please.yml) will create the tagged release triggering CircleCI to build and deploy the version at that tag.

## Contribute

Expand Down