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

Adds directories & email announcement for minor release #258

Closed

Conversation

anweshadas
Copy link
Collaborator

No description provided.

anweshadas added a commit to anweshadas/ansible-build-data that referenced this pull request Jul 13, 2023
@anweshadas anweshadas marked this pull request as ready for review July 13, 2023 13:44
Copy link
Collaborator

@mariolenz mariolenz left a 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.

@felixfontein
Copy link
Contributor

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.

Copy link
Contributor

@samccann samccann left a 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.

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:

Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a nit/discussion point - I think all collections in the package have a link to the repository on the docsite now. Do we want to switch the wording to point to that instead of galaxy?

image

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.
Copy link
Contributor

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.

@felixfontein
Copy link
Contributor

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:

Ansible X.0.0 includes ansible-core a.b.c as well as a curated set of Ansible collections that provide a vast number of modules and plugins.

Ansible X.0.0 consists of the "ansible" package, which contains the collections, and which depends on the "ansible-core" package.

@anweshadas
Copy link
Collaborator Author

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.

I am following this announcement template for 8.3.0 release announcement.


This release is available on PyPI and can be installed with pip:

`$ python3 -m pip install ansible==X.0.0 --user`
Copy link
Member

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:

Suggested change
`$ 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
Copy link
Member

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?
---------------------------------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

RST syntax in Markdown?

Copy link
Contributor

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`
Copy link
Member

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:
Copy link
Member

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.

anweshadas and others added 11 commits September 14, 2023 12:40
Pre-release
Post-release
Explains the ansible-core inclusion/requirement in ansible-community
package
…atrix

Co-authored-by: Carol Chen <2913667+cybette@users.noreply.github.com>
…atrix

Co-authored-by: Carol Chen <2913667+cybette@users.noreply.github.com>
…atrix

Co-authored-by: Carol Chen <2913667+cybette@users.noreply.github.com>
…mail.md

Co-authored-by: Mario Lenz <m@riolenz.de>
…mail.md

Co-authored-by: Mario Lenz <m@riolenz.de>
…mail.md

Co-authored-by: Mario Lenz <m@riolenz.de>
Adds the anouncement-email for pre-release.
Edits announcement-email for major release according to the feedback.
@felixfontein
Copy link
Contributor

How close / not close are the templates in this PR to what has been used for recent Ansible releases?

@felixfontein
Copy link
Contributor

@anweshadas and me took a quick look at this today, we decided to go through this and ansible-community/antsibull#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#573 is merged.

Otherwise we'll never get this done :-)

@felixfontein
Copy link
Contributor

ansible-community/antsibull#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/.

@gotmax23
Copy link
Contributor

@anweshadas, can we close this now that ansible-community/antsibull#573 has been merged?

@felixfontein
Copy link
Contributor

Yes, I guess we simply forgot to close it :) Let's do it now.

@felixfontein
Copy link
Contributor

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!

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.

None yet

7 participants