Skip to content

create draft release (triggered by master branch update) #1585

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

Closed
wants to merge 11 commits into from

Conversation

Bertk
Copy link
Collaborator

@Bertk Bertk commented Jan 12, 2024

This pipeline will reduce the effort for release documentation (#1579)

Chapters of release note are specified in configuration file .github\release-drafter.yml and PR labels are used to populate release note chapters.

Current label list of release-drafter.yml:
- breaking-change
- enhancement
- bug
- maintenance
- chore
- documentation
- dependencies
- security
- skip-changelog

Bold labels already exist in coverlet repository

…verage#1578)

* support multi target frameworks

* Update coverlet.collector.csproj
@Bertk Bertk removed the request for review from MarcoRossignoli January 16, 2024 08:42
@Bertk Bertk self-assigned this Jan 16, 2024
@daveMueller
Copy link
Collaborator

I think with release drafter we would be doing a fundamental switch on how we document our changes. Currently we focus on Github issues that we closed with our changes. But we don't reference the actual PR in the change log.
Release drafter does this differently. It references PRs without an explicit reference to the issues a PR closes. This means for us we must be much more precise on the title of PRs and also start tagging our PRs.

Personally I like it when there is an issue to a PR because it contributes to transparency for the community. When I work in other open source projects I often wonder about commits that I can't link to an issue. Release drafter doesn't exclude this option as issues can still be linked to PRs, but we need to be more careful with our PRs.

I think release drafter looks interesting and we can give it a try. But we also need to document the workflow for creating PRs then. On the other hand, I don't think maintaining our manual change log is much work. Let's see what @MarcoRossignoli thinks about it.

@Bertk
Copy link
Collaborator Author

Bertk commented Feb 1, 2024

I used issues as a source for release notes in the past. We created software for a regulated environment and followed internal quality regulations. There was no PR without a issue with defined content. This is not required here and not all PRs need a issue e.g. maintenance/chore.

release drafter will create information based on PRs but you are allowed to ignore it.

  • Nevertheless it creates a nice overview and which kann be reused for CHANGELOG.md.
  • The content can be tweaked during development using labels.

@Bertk Bertk closed this Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants