Skip to content

chore: re-generate changelogs - #32886

Merged
vladar merged 24 commits into
masterfrom
vladar/generate-changelogs
Aug 26, 2021
Merged

chore: re-generate changelogs#32886
vladar merged 24 commits into
masterfrom
vladar/generate-changelogs

Conversation

@vladar

@vladar vladar commented Aug 23, 2021

Copy link
Copy Markdown
Contributor

Description

  • Added tooling for changelog generation and auto-updates based on our release process conventions. See README for CLI usage.

  • Updated changelogs of all packages in master. Example: updated changelog for gatsby. Now each minor release links to release notes as well.

There are also some automation scripts:

Updates changelogs on lerna publish

Default changelogs generated by lerna are disabled globally in lerna.json.

This tool uses version lifecycle hook of lerna to automatically update changelogs on publish.

It only updates changelogs when stable releases are published. Pre-releases and canaries are ignored
(caveat: rc, alpha, beta versions won't get their changelog entries).

See version field in package.json on actual setup (uses lerna-version-lifecycle.js script from this new tool)

Updates changelogs in master automatically

Actual publishing happens in release/* branches, so changelogs in master get out of sync.

To sync them we need to update changelogs in master separately. This will happen automatically via update_changelogs job in CircleCI (will enable in a follow up after merging this PR). This job calls update-and-open-pr.js to update changelogs in the current branch and open a PR with suggested updates.

@gatsbot gatsbot Bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Aug 23, 2021
@vladar vladar added type: maintenance An issue or pull request describing a change that isn't a bug, feature or documentation change and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Aug 23, 2021
Comment thread scripts/gatsby-changelog-generator/README.md Outdated
Comment thread scripts/gatsby-changelog-generator/render.js Outdated
vladar added 10 commits August 25, 2021 19:25
# Conflicts:
#	packages/babel-plugin-remove-graphql-queries/CHANGELOG.md
#	packages/babel-preset-gatsby/CHANGELOG.md
#	packages/gatsby-admin/CHANGELOG.md
#	packages/gatsby-cli/CHANGELOG.md
#	packages/gatsby-core-utils/CHANGELOG.md
#	packages/gatsby-page-utils/CHANGELOG.md
#	packages/gatsby-plugin-gatsby-cloud/CHANGELOG.md
#	packages/gatsby-plugin-image/CHANGELOG.md
#	packages/gatsby-plugin-manifest/CHANGELOG.md
#	packages/gatsby-plugin-mdx/CHANGELOG.md
#	packages/gatsby-plugin-netlify/CHANGELOG.md
#	packages/gatsby-plugin-offline/CHANGELOG.md
#	packages/gatsby-plugin-page-creator/CHANGELOG.md
#	packages/gatsby-plugin-preload-fonts/CHANGELOG.md
#	packages/gatsby-plugin-sharp/CHANGELOG.md
#	packages/gatsby-plugin-typescript/CHANGELOG.md
#	packages/gatsby-recipes/CHANGELOG.md
#	packages/gatsby-remark-images/CHANGELOG.md
#	packages/gatsby-source-contentful/CHANGELOG.md
#	packages/gatsby-source-drupal/CHANGELOG.md
#	packages/gatsby-source-filesystem/CHANGELOG.md
#	packages/gatsby-source-shopify/CHANGELOG.md
#	packages/gatsby-source-wordpress/CHANGELOG.md
#	packages/gatsby-telemetry/CHANGELOG.md
#	packages/gatsby-transformer-remark/CHANGELOG.md
#	packages/gatsby-transformer-sqip/CHANGELOG.md
#	packages/gatsby/CHANGELOG.md
@KyleAMathews

Copy link
Copy Markdown
Contributor

Wanted to pop in and say I'm really excited about this!

@vladar
vladar force-pushed the vladar/generate-changelogs branch from d7b0c8c to 6f86ce1 Compare August 25, 2021 21:28
@vladar
vladar force-pushed the vladar/generate-changelogs branch from 33a0200 to 712d457 Compare August 25, 2021 22:16
raffishquartan pushed a commit to raffishquartan/gatsby that referenced this pull request Apr 28, 2026
* chore: re-generate changelogs

* updated all changelogs

* support incremental changelog updates

* add utils to update changelogs on publish

* Change release history URLs to something more useful

* several fixes

* replace lerna changelogs

* fix missing export

* re-generate changelogs again after merging master

* formatting fixes

* draft: open PR script

* simplify a bit

* use GITHUB_BOT_AUTH_TOKEN vs GITHUB_ACCESS_TOKEN

* update circle-ci config

* Trigger on stable releases only

* add python to job in ci

* cleanup / format

* fix for older node

* filter ci by release branches for now

For some reason filtering by tags doesn't work out of the box :/

* Disable in circleci untila a PR is merged

Will re-enabe in a follow up when changelogs in master are re-generated

* Update README

* fix changelog of gatsby-transformer-sharp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: maintenance An issue or pull request describing a change that isn't a bug, feature or documentation change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants