Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
35 changes: 35 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
changelog:
exclude:
labels:
- skip-changelog
authors:
- dependabot[bot]
- dependabot
- renovate

categories:
- title: Breaking Changes
commit_patterns:
- "^(?<type>\\w+(?:\\((?<scope>[^)]+)\\))?!:\\s*)"
semver: major
- title: Features
commit_patterns:
- "^(?<type>feat(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
semver: minor
- title: Fixes
commit_patterns:
- "^(?<type>fix(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
- '^Revert "'
semver: patch
- title: Enhancements
commit_patterns:
- "^(?<type>(?:perf|impr|enh)(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
semver: patch
- title: Dependencies
commit_patterns:
- "^(?<type>(?:deps)(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
- "^chore\\(deps\\): update CLI"
semver: minor
- title: Internal Changes
commit_patterns:
- "^(?<type>(?:build|refactor|meta|chore|ci|ref|tests?|style|docs)(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
16 changes: 8 additions & 8 deletions .github/workflows/changelog-preview.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: Changelog Preview
on:
pull_request_target:
pull_request:
Comment thread
buenaflor marked this conversation as resolved.
types:
Comment thread
buenaflor marked this conversation as resolved.
- opened
- synchronize
- reopened
- edited
- labeled
- unlabeled
- opened
- synchronize
- reopened
- edited
- labeled
- unlabeled
permissions:
contents: write
pull-requests: write
statuses: write

jobs:
changelog-preview:
uses: getsentry/craft/.github/workflows/changelog-preview.yml@v2
uses: getsentry/craft/.github/workflows/changelog-preview.yml@3e6a0f477702864bb5854384b390a0db3325428e # v2
secrets: inherit
11 changes: 0 additions & 11 deletions .github/workflows/danger.yml

This file was deleted.

74 changes: 64 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,11 @@
We love pull requests from everyone.
We suggest opening an issue to discuss bigger changes before investing on a big PR.

# Pull Requests

If a PR should notify a linked issue after release, use a GitHub closing keyword in the PR
description, such as `Fixes #123`, `Closes #123`, or `Resolves #123`. Release notification
automation only comments on issues GitHub recognizes as closed by the released PR; mentioning an
issue without a closing keyword is not enough.

# Requirements
## Requirements

The project currently requires you run Dart version >= `2.12.0`.

# Run
## Run

To build:

Expand All @@ -32,6 +25,67 @@ dart run
dartaotruntime bin/sentry_dart_plugin.aot
```

# CI
## CI

Build is automatically run against branches and pull requests via GH Actions.

# Pull Requests

If a PR should notify a linked issue after release, use a GitHub closing keyword in the PR
description, such as `Fixes #123`, `Closes #123`, or `Resolves #123`. Release notification
automation only comments on issues GitHub recognizes as closed by the released PR; mentioning an
issue without a closing keyword is not enough.

## Branch Naming

Use the format `git-username/type/short-description` for branch names.

* `git-username` should match your Git username or GitHub handle.
* `type` should be a conventional change type according to [conventional commits](https://www.conventionalcommits.org/) such as `feat`, `fix`, `docs`, `test`, or `chore`.
* `short-description` should be lowercase, hyphen-separated, and describe the change.

For example: `octocat/feat/add-http-timeout`.

## Changelog

Changelogs are generated automatically during the release process using
[craft](https://github.com/getsentry/craft). The policy is defined in
[`.github/release.yml`](.github/release.yml).

PR titles must follow [Conventional Commits](https://www.conventionalcommits.org/) format (e.g.,
`feat(scope): Add feature`, `fix: Handle null`) since craft uses them to categorize entries and
determine the semver bump. No manual changelog entries are needed. A changelog preview is posted on
each PR so you can verify how the entry will look before merging.

If a PR should be excluded from the changelog, apply the `skip-changelog` label.

If a PR should notify a linked issue after release, use a GitHub closing keyword in the PR
description, such as `Fixes #123`, `Closes #123`, or `Resolves #123`. Release notification
automation only comments on issues GitHub recognizes as closed by the released PR; mentioning an
issue without a closing keyword is not enough.

### Custom Changelog Entries from PR Descriptions

By default, the changelog entry for a PR is generated from its title. However, PR authors can
override this by adding a "Changelog Entry" section to the PR description. This allows for more
detailed, user-facing changelog entries without cluttering the PR title.

Add a markdown heading (level 2 or 3) titled "Changelog Entry" to your PR description, followed by
the desired changelog text:

```markdown
### Description

Add `foo` function, and add unit tests to thoroughly check all edge cases.

### Motivation & Context

Closes #123

### Changelog Entry

Add a new function called `foo` which prints "Hello, world!"
```

The text under "Changelog Entry" will be used verbatim in the changelog instead of the PR title. If
no such section is present, the PR title is used as usual.
Loading