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

Ci/automate updating the CHANGELOG.md files #1879

Merged
merged 11 commits into from
May 19, 2024

Conversation

ellet0
Copy link
Collaborator

@ellet0 ellet0 commented May 19, 2024

Description

This PR aims to update #1878 changes to also automate the generation of the CHANGELOG.md files, the maintainers are no longer required to manually change the version.dart and the root CHANGELOG.md then run the script, and after that commit the changes and push them, then create a Github release to automate the publishing

now, you just have to create a new GitHub release, you can use the auto-generate release notes button or manually type the changes and once you click the publish button, the CI will automate this whole process, I migrated all the previous data from CHANGELOG.md to CHANGELOG.json (using another quick script that's not in the project)

Don't get confused by this:
image

It's mostly due to auto-generated CHANGELOG.md files, this PR doesn't change much other than the GitHub workflow, the script, the development notes, and a few changes, I should have let GitHub actions run the script instead but it will be overwritten and doesn't matter that much,

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I titled the PR using Conventional Commits.
  • I did not modify the CHANGELOG.md nor the plugin version in pubspec.yaml files.
  • All existing and new tests are passing.
  • I have run the commands in ./scripts/before_push.sh and it all passed successfully

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate that with a ! in the title as explained in Conventional Commits).
  • No, this is not a breaking change.

@ellet0 ellet0 marked this pull request as ready for review May 19, 2024 20:32
@ellet0 ellet0 merged commit 0edb4b9 into master May 19, 2024
2 checks passed
@ellet0 ellet0 changed the title Ci/automate changelog publishing Ci/automate updating the CHANGELOG.md files May 19, 2024
@ellet0
Copy link
Collaborator Author

ellet0 commented May 20, 2024

Since I wasn't able to test the changes locally using act or other solutions, I should have tested the changes and tested the publishing workflow in this branch directly instead of the master branch

@ellet0 ellet0 deleted the ci/automate-changelog-publishing branch June 13, 2024 10:34
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.

None yet

1 participant