Skip to content

docs: add new package release process #1734

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

Merged
buenaflor merged 6 commits into from
Dec 12, 2023
+57 −0
Merged

docs: add new package release process #1734

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f58b22e
add docs
buenaflor Nov 16, 2023
187f7fc
Add flutter example step
buenaflor Nov 16, 2023
bc9d0c8
Add analyze info
buenaflor Nov 16, 2023
056b200
Update
buenaflor Nov 17, 2023
6c8c5eb
Update new-package-release-checklist.md
buenaflor Nov 29, 2023
54fbc64
Update new-package-release-checklist.md
buenaflor Nov 29, 2023
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
Prev Previous commit
Next Next commit
Update new-package-release-checklist.md
  • Loading branch information
@buenaflor
buenaflor authored Nov 29, 2023
commit 6c8c5eb269b308c6185b2c41f3e76e22003984b2
8 changes: 6 additions & 2 deletions docs/new-package-release-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This page serves as a checklist of what to do when releasing a new package for t
- [ ] The package only exports the public API
- [ ] The package contains an example folder
- [ ] The package contains a README.md file
- [ ] CI badges show a status
- [ ] The package contains a CHANGELOG.md file (symlink to the root changelog)
- [ ] The package contains a dartdoc_options.yaml file (symlink to the root file)
- [ ] The package contains a LICENSE (default is `MIT`)
Expand All @@ -24,14 +25,16 @@ This page serves as a checklist of what to do when releasing a new package for t

- [ ] Excluding `your-package-name.yml`, add the package to the `paths-ignore` section of all package workflow files.
- For examples see `sqflite.yml`, `dio.yml` etc...

- [ ] Add an entry to [diagram.yml](https://github.com/getsentry/sentry-dart/blob/main/.github/workflows/diagrams.yml) for your package.

- [ ] In the root `.gitignore` file add the package coverage as ignored.

The `analyze` workflow will fail in your PR and in the main branch because the package is not released yet and the `pubspec.yaml` is not 'valid' according to the analyzer.
This is expected - it will succeed after the release.
- [ ] Make sure the analyze workflow doesn't have other failures, only the one mentioned above.

- [ ] **The most important**: add your package to `scripts/bump-version.sh`.
- [ ] **Very important**: add your package to `scripts/bump-version.sh`.

## Doing the Release

Expand All @@ -50,4 +53,5 @@ Do these steps in the **correct order**
- [Example PR](https://github.com/getsentry/sentry-release-registry/pull/136)
- [ ] Add an entry to `.craft.yml` for the package in the `registry` section.
- Now all future releases will be added to the registry automatically.
- [ ] Update the repo's `README.md`
- [ ] Update the repo's `README.md`
- [ ] Prepare and merge [Sentry documentation](https://github.com/getsentry/sentry-docs/)https://github.com/getsentry/sentry-docs/