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(gatsby-adapter-netlify): add CHANGELOG.md #38848

Merged
merged 3 commits into from
May 7, 2024
Merged

Conversation

pieh
Copy link
Contributor

@pieh pieh commented Feb 2, 2024

Description

Check preview

Our automated changelog generator/updater wasn't generating changelog for gatsby-adapter-netlify because there wasn't CHANGELOG.md boilerplate added at the time package was initially introduced - this adds generated version (locally) that should be updated with bot in the future

FRA-265

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Feb 2, 2024
@pieh pieh added type: documentation An issue or pull request for improving or updating Gatsby's documentation topic: adapters Related to Gatsby Adapters and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Feb 2, 2024

- Adapters [#38232](https://github.com/gatsbyjs/gatsby/issues/38232) ([b2d4aef](https://github.com/gatsbyjs/gatsby/commit/b2d4aefa7716e3ef02a19b530a8a7e4678d086e1))

<a name="before-release-process"></a>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lack of above marker (and file in general) was causing changelog generation scripts to skip generating changelog for adapter:

const path = changelogPath(packageName)
const separator = `<a name="before-release-process"></a>`
const contents = String(fs.readFileSync(path))
const parts = contents.split(separator)
if (parts.length !== 2) {
throw new Error(`Could not find demarcation ${separator.trim()} in ${path}`)
}

const contents = String(fs.readFileSync(path))

@pieh pieh marked this pull request as ready for review February 20, 2024 18:51
@MarcL
Copy link

MarcL commented Apr 25, 2024

@pieh - Want to rebase with master and we can get it approved and merged?

@pieh pieh merged commit 7cea40b into master May 7, 2024
7 checks passed
@pieh pieh deleted the docs/adapter-changelog branch May 7, 2024 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: adapters Related to Gatsby Adapters type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants