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

Add release notes page and release notes for 3.4 specifically. #2115

Merged
merged 12 commits into from
Jan 27, 2025

Conversation

lengau
Copy link
Collaborator

@lengau lengau commented Jan 24, 2025

Done in steps as 3 separate commits, but really one logical addition.

CRAFT-3996

@lengau lengau added the rebase label Jan 24, 2025
@lengau lengau self-assigned this Jan 24, 2025
@lengau lengau requested a review from medubelko as a code owner January 24, 2025 21:44
@lengau lengau requested a review from bepri January 24, 2025 21:44
@lengau lengau force-pushed the docs/release-notes-3.4 branch from ed271c4 to 382e5fb Compare January 24, 2025 21:48
@bepri
Copy link
Contributor

bepri commented Jan 24, 2025

Copy link
Contributor

@bepri bepri left a comment

Choose a reason for hiding this comment

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

There's a couple more instances of "Starcraft" in the templates, up to you if you want to fix those.

docs/release-notes/charmcraft-3.4.0.rst Outdated Show resolved Hide resolved
docs/release-notes/charmcraft-3.4.0.rst Outdated Show resolved Hide resolved
docs/release-notes/charmcraft-3.4.0.rst Outdated Show resolved Hide resolved
docs/release-notes/index.rst Outdated Show resolved Hide resolved
@lengau lengau force-pushed the docs/release-notes-3.4 branch from 27e23ab to 9f7d415 Compare January 24, 2025 21:59
@lengau lengau requested a review from bepri January 24, 2025 22:00
Copy link
Contributor

@bepri bepri left a comment

Choose a reason for hiding this comment

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

Looks good, just missing a period here still I think :)

docs/release-notes/index.rst Outdated Show resolved Hide resolved
This has the bonus effect of fixing a duplicate ref error.
Disable the lint check for underscores after links (`text<link>`_) so that it doesn't give us grief over literalrefs. This is compensating for our own extension, not sphinx-lint itself.
Copy link
Contributor

@medubelko medubelko left a comment

Choose a reason for hiding this comment

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

@lengau This is very good work! I like what you've put together here.

I've made many minor tweaks here and there for language, and fixed the build errors.

I take it we're not moving the changelog because of how many links it would break. It makes sense to me to make that move dependent on the future redirect extension.

docs/release-notes/charmcraft-3.4.0.rst Show resolved Hide resolved
docs/release-notes/charmcraft-3.4.0.rst Outdated Show resolved Hide resolved
docs/reuse/links.txt Outdated Show resolved Hide resolved
@lengau
Copy link
Collaborator Author

lengau commented Jan 27, 2025

@medubelko thanks for your updates! Indeed I am waiting for us to have a redirector before I move the changelog.

I've made one change to the snapd references and we should be ready to go, but I'd prefer if we can solve the "related issue" stuff today.

@lengau lengau requested a review from jahn-junior January 27, 2025 16:06
@lengau lengau merged commit b0f4e3c into main Jan 27, 2025
28 checks passed
@lengau lengau deleted the docs/release-notes-3.4 branch January 27, 2025 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants