Skip to content

Add a changelog section, common to both variants #28

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

Open
wants to merge 12 commits into
base: dev
Choose a base branch
from

Conversation

nord-erik
Copy link

@nord-erik nord-erik commented Jul 14, 2025

Of course there are some differences between BigQuery and Google Cloud in terms
of documentation. But I decided for simplicity to have the same changelog for
both -- it's the same source code for both. Interpreted both git history and code
changes to figure out major differences between the different releases.

Trello Card

extracted using command:

```
git log --format="%H" --since="2024-01-09 00:00:00" -- src/ \
  | xargs -I{} bash -c 'printf "%s %s\n" "{}" "$(git tag --contains {} | head -n1)"'\
  | awk '{print $2;}'\
  | uniq\
  | awk '{print "==" $1}'
```
Changes were determined if they shipped in a release with:

```
git log --format="%H" --since="2024-01-10 00:00:00" -- src \
  | xargs -I{} bash -c 'printf "%s %s\n" "{}" "$(git tag --contains {} | head -n1)"'
```

Then to determine what actually did change:

```
git log --format="%s" 2025-01-22-01_RC01..2025-01-26-00_RC00 -- src \
  | awk '{print "* "$0;}'
```

Did not include test changes, minor changes etc.
Reworded to make sense from someone reading just this changelog
@nord-erik nord-erik marked this pull request as ready for review July 14, 2025 15:12
@stefano-ottolenghi
Copy link
Collaborator

@nord-erik 👋 #29 fixed the previews not being available. You will now find that the top link to surge.sh works, with a landing that gives you access to the two docsets. However, the Changelog links don't work. That's because the related pages are not included in content-nav.yml, and the docs automation strips away from publishing anything that's not explicitly referenced in the navigation. Adding an entry to the navigation for the changelog (in both docsets) should fix the issue.

@fbiville fbiville self-requested a review July 15, 2025 08:21
@nord-erik
Copy link
Author

Hi @stefano-ottolenghi , thanks a lot for the info! I see Florent is already on it

@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-dataflow-connector-28.surge.sh

New pages:

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

Successfully merging this pull request may close these issues.

4 participants