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

build: improve changelog parsing and order #768

Merged
merged 3 commits into from
Aug 10, 2023

Conversation

Mishura4
Copy link
Member

@Mishura4 Mishura4 commented Aug 9, 2023

  • Added the ability for the parser to parse more patterns :
    • A commit with several categories, e.g. foo, bar: many foos, many bars. Only the first category is taken into account, but all of them are split and parsed with a regex, so they can easily be used if needed. ❗ Commits marked as breaking will always be listed at the top the changelog in the breaking section (alongside their own category if the breaking was a secondary category)
    • A commit with a scope, e.g. feat(scope): some changes, all commits with the same scope will be grouped together in the changelog, listed as Scope: some changes
  • Fixed the order of the categories, which are now listed in declaration order, as opposed to in the order of the first commit that references them
  • The script will warn if a commit has failed to parse a category, and now add them to misc. Warnings are generated on stderr and can be silenced using shell redirection

All other behavior was left intact.

Changelog after this commit:

The changelog is listed below:

Release Changelog
===========

## ✨ New Features
- Add SPDX-License-Identifier to headers in files
- Introduce the media channel type (#746)
- Adding AVX implementation for mixing audio. (#745)
- Add STDCORO to cspell
- Add `dpp::snowflake::str()` that returns string form of snowflake value
- Added functionality for guild onboarding and welcome screen (#734)

## 🐞 Bug Fixes
- Fix dodgy search and replace, vscode inserting newlines
- Fix spelling error
- `default` empty destructors
- Delete copy and move assignment operators for cluster
- Workaround gcc-12 bug #105329 (#748)
- Coroutines: better support for clang, remove experimental if unneeded, add missing headers (#743)
- Warning for [=] copy without explkit , rerun coro builder for onboarding
- Add /bigobj to non-VCPKG MSVC CMake flags, fixing ninja build, and fix `CMakeSettings.json` (#740)

## ♻️ Refactoring
- Change `interaction_response.msg` from message* to message, fixing double free on copy (#762)
- Json parsing helper functions added to unify the way arrays are parsed (#744)
- Use nullptr instead of NULL
- Use structured bindings
- Change `std::for_each` to ranged for loops

## 📚 Documentation
- Add openssf scorecard to readme
- Add spelling
- Fix typo (#741)
- Some tweaks in code examples (#742)
- Documentation for `unicode_emoji` namespace (#739)

## 📜 Miscellaneous Changes
- Create `pull_request_template.md`
- Update `scorecard.yml`
- Update `dependabot.yml`
- OpenSSF best practices badge (#766)
- Update `README.md`
- D++ == CHAD++ // true (#747)
- Clang-tidy namespace comment autofix
- Update `codeql.yml`
- Update `SECURITY.md`
- Create `scorecard.yml`
- Enable CORO on g++11, g++12, osx
- Dont enable AVX when compiling on GHA
- Update `CONTRIBUTING.md`
- Update `CONTRIBUTING.md` - add rules about not just using automated tools to generate bad prs

## 👷 Build/CI
- Improve changelog parsing and order
- Add signing shell script to auto sign releases with gpg and upload .asc alongside artifacts
- Apply security best practices (#749)


**Thank you for using D++!**

STDERR output :

PHP Warning:  could not guess category for commit "Create `pull_request_template.md`", adding it to misc in /home/miuna/dev/DPP/buildtools/changelog.php on line 234
PHP Warning:  could not guess category for commit "OpenSSF best practices badge (#766)", adding it to misc in /home/miuna/dev/DPP/buildtools/changelog.php on line 234
PHP Warning:  could not guess category for commit "D++ == CHAD++ // true (#747)", adding it to misc in /home/miuna/dev/DPP/buildtools/changelog.php on line 234
PHP Warning:  could not guess category for commit "Create `scorecard.yml`", adding it to misc in /home/miuna/dev/DPP/buildtools/changelog.php on line 234
PHP Warning:  could not guess category for commit "enable CORO on g++11, g++12, osx", adding it to misc in /home/miuna/dev/DPP/buildtools/changelog.php on line 234
PHP Warning:  could not guess category for commit "dont enable AVX when compiling on GHA", adding it to misc in /home/miuna/dev/DPP/buildtools/changelog.php on line 234

@netlify
Copy link

netlify bot commented Aug 9, 2023

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 8e2b104
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/64d510a3bc50eb0008f3c415
😎 Deploy Preview https://deploy-preview-768--dpp-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@braindigitalis braindigitalis merged commit 877d7d5 into brainboxdotcc:dev Aug 10, 2023
11 checks passed
@Commandserver Commandserver added the enhancement New feature or request label Aug 12, 2023
@Mishura4 Mishura4 deleted the changelog-fix branch August 22, 2023 17:16
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.

3 participants