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

Ensure we can automate the list of API changes for major release changelog #345

Open
1 of 4 tasks
GuySartorelli opened this issue Dec 1, 2024 · 1 comment
Open
1 of 4 tasks
Assignees

Comments

@GuySartorelli
Copy link
Member

GuySartorelli commented Dec 1, 2024

For CMS 5.0.0 we used https://github.com/emteknetnz/silverstripe-deprecator/blob/main/src/DeprecationDiffTask.php to automate the list of API breaking changes from 4.x to 5.0.0.

There's some hardcoded references in there and no documentation, so reusing it requires some amount of re-learning at least, if not reworking bits of it to work again.

Ideally this process would be built into cow, so we can just run through the release process docs and run the commands it says to run, with expected results.

Acceptance criteria

  • At a minimum, make sure that task can work for the 6.0.0-alpha1 changelog for Release CMS 6 alpha #340
  • Ideally implement a command in cow (or include this in the existing changelog command) so that future major releases are more streamlined.
    • Should include turning off linting rules proper-names enhanced-proper-names title-case-style so the linter doesn't get mad
    • Any markdown reserved characters in deprecation notice messages are escaped appropriately
@GuySartorelli
Copy link
Member Author

I got this as done as it was needed for the immediate releases. I can keep using what I have locally for the rest of 6 if needs be, and then come back to this afterward for future majors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant