Skip to content

Changelog for Release server-2025-07-01 #11188

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

Merged
merged 2 commits into from
Jul 1, 2025
Merged

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jul 1, 2025

Changelog for Release server-2025-07-01

@github-actions github-actions bot added the release PRs with this label will create a tag when merged label Jul 1, 2025
@chris48s
Copy link
Member

chris48s commented Jul 1, 2025

@jNullj - a note on how this release automation works

We put out a monthly tagged snapshot release on DockerHub.
https://github.com/badges/shields/blob/master/doc/releases.md#server-releases

There's a workflow that runs once a month that generates a draft changelog and opens a PR to prompt us to do this. So this PR is the outcome of
https://github.com/badges/shields/blob/master/.github/workflows/draft-release.yml running
https://github.com/badges/shields/blob/master/.github/actions/draft-release/entrypoint.sh
This exists to partially automate drafting the changelog and also to give us a reminder to put the release out. We can also manually trigger this workflow at https://github.com/badges/shields/actions/workflows/draft-release.yml if we want to do an out of sequence release (e.g: due to a security fix).

Once this PR is open, the next stage is a manual review/edit of the changelog. There's 2 things I do here:

  1. Call out any really important or breaking changes at the top of the changelog entry. So for example,
    **Deprecation:** For users who need to maintain a Github Token pool, storage has been provided via the `RedisTokenPersistence` and `REDIS_URL` settings. As of this release, the `RedisTokenPersistence` backend is now deprecated and will be removed in a future release. If you are using this feature, you will need to migrate to using the `SQLTokenPersistence` backend for storage and provide a postgres connection string via the `POSTGRES_URL` setting. [#8922](https://github.com/badges/shields/issues/8922)
    or

    shields/CHANGELOG.md

    Lines 100 to 105 in 011174d

    This release includes an important security fix. See
    - https://github.com/badges/shields/security/advisories/GHSA-rxvx-x284-4445
    - https://github.com/badges/shields/issues/10553
    for more details
    were things I added manually
  2. Reduce noise. I usually remove any changelog entries for things like documentation updates or fixing service tests. Essentially, my objective here is to try and make sure the list of things in the changelog are things a person hosting their own instance of shields might want or need to know about.

Having updated the changelog, I then merge the PR. This will trigger a second workflow https://github.com/badges/shields/blob/master/.github/workflows/create-release.yml (the key thing here is merging a PR with the "release" label) which tags the repo and pushes a tagged image to DockerHub.

If you want to pick this up, you should be able to approve and merge it even if you've also pushed commits to the branch editing the changelog.

One final note on this:
If we've merged more PRs inbetween this PR being automatically opened and when we get to reviewing it, the changlog will be out of date. If this happens, I usually just close the changelog PR and re-trigger the workflow in https://github.com/badges/shields/actions/workflows/draft-release.yml to generate an up-to-date changelog.

@jNullj
Copy link
Member

jNullj commented Jul 1, 2025

Thank you for guiding me over the process, with in depth explanations and your own point of view.
I will use this release as an opportunity to run the process for the first time on my own.

Copy link
Contributor Author

github-actions bot commented Jul 1, 2025

Messages
📖

✨ Thanks for your contribution to Shields, @github-actions[bot]!

📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against 93ed481

@jNullj jNullj added this pull request to the merge queue Jul 1, 2025
Merged via the queue into master with commit 464f71a Jul 1, 2025
29 checks passed
@jNullj jNullj deleted the server-2025-07-01-22b7f9ee branch July 1, 2025 20:31
@jNullj
Copy link
Member

jNullj commented Jul 1, 2025

Release github action seems to work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release PRs with this label will create a tag when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants