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

docs: update CHANGELOG with new version of liferay-changelog-generator #46

Merged
merged 2 commits into from
Mar 2, 2020

Conversation

wincent
Copy link
Contributor

@wincent wincent commented Mar 2, 2020

Regenerating to make sure these two pulls to the generator are good before publishing a new release:

So this is just a test of those, done with:

../liferay-npm-tools/packages/liferay-changelog-generator/bin/liferay-changelog-generator.js \
  --from=v4.11.3-liferay.0 \
  --to=v4.13.1-liferay.3 \
  --version=v4.13.1-liferay.3 \
  --regenerate \
  --force

See the second commit message for an explanation of why we need to tweak the Prettier settings (the short version: to make the changelog format match what we use in other repos).

Regenerating to make sure these two pulls to the generator are good
before publishing a new release:

- liferay/liferay-npm-tools#398
- liferay/liferay-npm-tools#399

So this is just a test of those, done with:

    ../liferay-npm-tools/packages/liferay-changelog-generator/bin/liferay-changelog-generator.js \
      --from=v4.11.3-liferay.0 \
      --to=v4.13.1-liferay.3 \
      --version=v4.13.1-liferay.3 \
      --regenerate \
      --force
Comparing the effect of running `yarn format` in this repo with others,
it was changing the indent of bullet lists in our CHANGELOG in a way
that doesn't match the other repos. This is a problem because we have
tuned the output of liferay-changelog-generator to match what `prettier
format` expects — so we need it to behave exactly the same in all repos.

This commit adds the minimal config necessary to make the Markdown
output match, but note that because it is repo-wide, it also affects the
JS and JSON files, which seems fine.
@wincent
Copy link
Contributor Author

wincent commented Mar 2, 2020

Just a doc update, so going to merge this.

@wincent wincent merged commit e160e7a into master Mar 2, 2020
@wincent wincent deleted the wincent/update-changelog branch March 2, 2020 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant