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: Add CHANGELOG configuration #30

Merged
merged 1 commit into from
May 7, 2021
Merged

Conversation

embano1
Copy link
Member

@embano1 embano1 commented May 7, 2021

Description

Configuration for creating a CHANGELOG file and release annotation in upcoming releases. Will be used by Github Actions.
Currently the following commit title prefixes are defined as highlighted sections:

  • feat: - Feature
  • fix: - Bug Fix
  • chore: - Chore/Repo activities

Example:

v0.2.0

Release Date: 2021-05-07

🧹 Chore

  • Add CHANGELOG configuration
  • Verify PRs and push to main
  • Add stale action

📖 Commits

  • chore: Add CHANGELOG configuration [5764180]
  • Add PR template [a0e1078]
  • Update issue templates [ae6f848]
  • Improve examples. Remove unnecessary details. [3a9010a]
  • Implement wait server to start in the integrations tests BeforeAll Fix Binary Mode HTTP Header DateTime format. It is UTC time formatted in ISO 8601 format including milliseconds. Bump revision of the module version [401a475]
  • chore: Verify PRs and push to main [0bd4192]
  • chore: Add stale action [e08a275]
  • Add Install Module Instructions to README (#17) [3629c77]
  • Enable process exit in build.ps1 [aac584a]
  • Create CONTRIBUTING.md (#15) [84606b0]
  • Renames Add-CloudEventData to Set-CloudEventData (#12) [d305f16]
  • Adds license headers in source code files (#11) [f23df54]
  • Remove install instructions from an internal PS repository (#10) [62f14b6]
  • Initial commit [b2afcf8]

Closes: #29
Signed-off-by: Michael Gasch [email protected]

Type of change

Please mark options that are relevant:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

$ git-chglog --next-tag v0.2.0 v0.2.0

Test Configuration:

  • Toolchain:
  • SDK:
  • (add more if needed)

Checklist:

  • My code follows the contribution
    guidelines
    of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@embano1 embano1 requested a review from dmilov May 7, 2021 09:42
@embano1 embano1 added the enhancement New feature or request label May 7, 2021
@embano1 embano1 merged commit b479886 into cloudevents:main May 7, 2021
@embano1 embano1 deleted the issue-29 branch May 7, 2021 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create CHANGELOG
2 participants