Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎫 Ticket
No ticket
🗒️ Description
See original PR here
This PR seeks to mimic the above but for ET. Most of the code is just copied over, the only non-global changes are:
- bin/class-tec-changelog-formatter.php -> file name can be changed to match the plugin
- bin/class-tec-changelog-formatter.php L3 ->
* Jetpack Changelogger Formatter for The Events Calendar
- bin/class-tec-changelog-formatter.php L5 ->
* @package The Events Calendar
- bin/class-tec-changelog-formatter.php L14 ->
* Jetpack Changelogger Formatter for The Events Calendar
- bin/class-tec-changelog-formatter.php L16 ->
* Class TEC_Changelog_Formatter
- bin/class-tec-changelog-formatter.php L18 ->
class TEC_Changelog_Formatter extends Parser implements FormatterPlugin {
- bin/class-tec-changelog-formatter.php L40 ->
private $title = '# The Events Calendar Changelog';
- changelog.md -> entire file is plugin specific... I see in ET that it has a
changelog.txt
but not.md
- composer.json -> The lines vary so it's important to pay attention to which section you're adding them to.
- Also this line has tec in it:
"filename": "bin/class-tec-changelog-formatter.php"
-> make sure to change to whatever you changed the file to!Steps for testing
1. Checkout PR branch
feature/changelogger
2. In terminal, run
npm install
-> this will add all the changes added in the new files3. Run
composer install
-> this will install the new dependencies added4. Run
npm run changelog
-> This will create a new changelog file, with prompts for each required section.5. Look at the generated changelog in the new
/changelog
directory.6. Test adding a second entry and see that it makes another, separate file.
7. Test generating the changelog with the
command
./bin/process-changelog.sh 6.5.7 6.5.2 generate "2024-06-28"
->[file with command] [new version number] [old version number] [action type] [today's date]
- Worth noting that the readme.txt is only updated when the versions match
🎥 Artifacts
✔️ Checklist
readme.txt
file.wpunit
orintegration
tests.wpunit
orintegration
tests.