Skip to content

deps: remove no longer used changelog-maker devDep #124

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

Merged
merged 1 commit into from
Feb 15, 2025

Conversation

agilgur5
Copy link
Owner

@agilgur5 agilgur5 commented Feb 15, 2025

Summary

Remove @agilgur5/changelog-maker from devDeps and scripts

Details

  • I used my fork of changelog-maker for some time, but now my process is more involved

    • I manually categorize, summarize, and minimize changes
      • a good chunk of this could be automated by reading the semantic / conventional commit titles, but not entirely (e.g. when a change can fit multiple types or scopes)
    • I use GitHub Releases' "Generate release notes" feature for the first draft / list of commits + PRs, as with v1.1.0-alpha.1
      • unlike changelog-maker, GH's feature does not require a PR-URL: <url> to exist in the commits to be able to reference the PR
      • I'd like to use a more cross-platform tool that is not reliant on GH, but this is the easiest option right now
  • removing this outdated devDep also removes any remaining vulns in the devDeps

    • these didn't affect prod built code and were not exploitable, so were super low priority to fix mainly for less scanner noise

Future Work

  1. better automate the changelog
  2. make a GH job to publish to NPM and create the GH release
    • start with manual version bumps for now, but with releases via CI

- I used [my fork of `changelog-maker`](https://github.com/agilgur5/changelog-maker) for some time, but now my process is more involved
  - I manually categorize, summarize, and minimize changes
    - a good chunk of this could be automated by reading the semantic / conventional commit titles, but not entirely (e.g. when a change can fit multiple types or scopes)
  - I use GitHub Releases' "Generate release notes" feature for the first draft / list of commits + PRs
    - unlike `changelog-maker`, GH's feature does not require a `PR-URL: <url>` to exist in the commits to be able to reference the PR
    - I'd like to use a more cross-platform tool that is not reliant on GH, but this is the easiest option right now

- removing this outdated devDep also removes any remaining vulns in the devDeps
  - these didn't affect prod built code and were not exploitable, so were super low priority to fix mainly for less scanner noise

Future Work:
1. better automate the changelog
1. make a GH job to publish to NPM and create the GH release
  - start with manual version bumps for now, but with releases via CI
@agilgur5 agilgur5 added kind: internal Changes only affect the internals and not the API or usage scope: dependencies Pull requests that update a dependency file labels Feb 15, 2025

This comment was marked as resolved.

Copy link
Owner Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM

@agilgur5 agilgur5 merged commit 75ccb72 into main Feb 15, 2025
8 checks passed
@agilgur5 agilgur5 deleted the deps-remove-changelog-maker branch February 15, 2025 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: internal Changes only affect the internals and not the API or usage scope: dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant