-
Notifications
You must be signed in to change notification settings - Fork 43
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
Adds directories & email announcement for minor release #258
Adds directories & email announcement for minor release #258
Conversation
docs/ansible-release-announcement/minor-release/announcement-email.md
Outdated
Show resolved
Hide resolved
1ae28ed
to
345d0b0
Compare
As discussed in ansible-community#258
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't have a closer look yet, but there are some small things I would change.
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/minor-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/minor-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/minor-release/announcement-email.md
Outdated
Show resolved
Hide resolved
How about reverting e66ce32 and then merging this, and only after that start with a new PR to improve this? That would IMO hugely improve readability. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Things started to repeat in the different files so I stopped repeating my suggestions. None of these are required for the Tuesday release BTW so no need to rush.
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
The changelog for ansible-core a.b installed by this release of Ansible X can be found here: <changelog of ansible-core> | ||
|
||
Collections which have opted-in to being a part of the Ansible X unified changelog will have an entry on this page: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems to me the changelogs for Ansible X include the core changelogs. So perhaps these two sentences should be switched to say the collection that opted in blablabla changelog is at .
And then the second sentence states this changelog also includes the core changelogs?
Collections which have opted-in to being a part of the Ansible X unified changelog will have an entry on this page: | ||
|
||
For collections which have not opted-in to the unified changelog, you may find more information on https://galaxy.ansible.com or the collection source repository. For example, the community.crypto collection is available at https://galaxy.ansible.com/community/crypto and you can find a link to the source repository under the "Repo" button at the top right. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/ansible-release-announcement/minor-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/minor-release/announcement-email.md
Outdated
Show resolved
Hide resolved
Getting collection updates from Ansible X with older releases of ansible-core | ||
-------------------------------------- | ||
|
||
Ansible X includes ansible-core a.b. Based on your requirements, you can get collection updates as they ship in the Ansible "batteries included" package while continuing to use older versions of ansible-core. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the time comes and the group decides on a better way to phrase the ansible-core dependency, this is another place to update it.
docs/ansible-release-announcement/minor-release/announcement-matrix
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-matrix
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-matrix
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
I would revert these paragraphs to the original version (https://github.com/ansible-community/ansible-build-data/blob/31da36426e49f598e324d08d3ebdec89a8ba4727/docs/ansible-release-announcement/major-release/announcement-email.md and https://github.com/ansible-community/ansible-build-data/blob/31da36426e49f598e324d08d3ebdec89a8ba4727/docs/ansible-release-announcement/minor-release/announcement-email.md) for now, and then start a separate discussion on how we can improve these. As for how this could be written IMO:
|
I am following this announcement template for 8.3.0 release announcement. |
docs/ansible-release-announcement/major-release/announcement-email.md
Outdated
Show resolved
Hide resolved
|
||
This release is available on PyPI and can be installed with pip: | ||
|
||
`$ python3 -m pip install ansible==X.0.0 --user` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of inline, use a code block with proper lexer:
`$ python3 -m pip install ansible==X.0.0 --user` | |
```console | |
$ python3 -m pip install ansible==X.0.0 | |
``` |
Also I wouldn't steer newbies towards --user
. In general, offering a pipx
command would be a better idea since it manages per-app venvs automatically.
💽 You can install it by running the following command or download the [release tarball](link to release tarball from PyPI) directly from [pypi](https://pypi.org/project/ansible/): | ||
|
||
``` | ||
pip install ansible==X.0.0 --user |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same sentiment regarding the block highlighting, --user
and pipx.
|
||
|
||
What's the schedule for new Ansible releases after X.0.0? | ||
--------------------------------------------------------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RST syntax in Markdown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is actually MarkDown (CommonMark): https://spec.commonmark.org/0.31.2/#setext-headings
|
||
This release is available on PyPI and can be installed with pip: | ||
|
||
`$ python3 -m pip install ansible==X.0.0 --user` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above.
|
||
`$ python3 -m pip install ansible==X.0.0 --user` | ||
|
||
The sources for this release can be found here: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only one is the source distribution, the other is called a built distribution.
Pre-release Post-release
As discussed in ansible-community#258
Explains the ansible-core inclusion/requirement in ansible-community package
…atrix Co-authored-by: Carol Chen <[email protected]>
…atrix Co-authored-by: Carol Chen <[email protected]>
…atrix Co-authored-by: Carol Chen <[email protected]>
…mail.md Co-authored-by: Mario Lenz <[email protected]>
…mail.md Co-authored-by: Mario Lenz <[email protected]>
…mail.md Co-authored-by: Mario Lenz <[email protected]>
…mail.md Co-authored-by: Mario Lenz <[email protected]>
…mail.md Co-authored-by: Mario Lenz <[email protected]>
…mail.md Co-authored-by: Mario Lenz <[email protected]>
…mail.md Co-authored-by: Sandra McCann <[email protected]>
…mail.md Co-authored-by: Sandra McCann <[email protected]>
…mail.md Co-authored-by: Sandra McCann <[email protected]>
…mail.md Co-authored-by: Sandra McCann <[email protected]>
2500fc3
to
f86f4a4
Compare
Adds the anouncement-email for pre-release. Edits announcement-email for major release according to the feedback.
How close / not close are the templates in this PR to what has been used for recent Ansible releases? |
@anweshadas and me took a quick look at this today, we decided to go through this and ansible-community/antsibull-build#573 in parallel on Wednesday (during the Ansible collab) and incorporating all parts from here to the antsibull PR so we can close this PR. If anyone wants text changes afterwards, they can create PR in the antsibull repository after ansible-community/antsibull-build#573 is merged. Otherwise we'll never get this done :-) |
ansible-community/antsibull-build#579 contains some of the unresolved improvements. Once that's merged I'm planning on closing this. If you want further improvements, please create PRs (or issues with concrete change proposals) for https://github.com/ansible-community/antsibull/. |
@anweshadas, can we close this now that ansible-community/antsibull-build#573 has been merged? |
Yes, I guess we simply forgot to close it :) Let's do it now. |
Thanks everyone for all the comments, and of course @anweshadas for getting this started! If you have further improvements for the current announcements, please create issues or PRs in the antsibull repositories. Thanks! |
No description provided.