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

ansible-readme.rst: mention the ansible-build-data issue tracker #554

Merged
merged 2 commits into from
Nov 22, 2023

Conversation

gotmax23
Copy link
Contributor

@gotmax23
Copy link
Contributor Author

The check_package_files tests are going to fail until I update the generated READMEs in the test_data. I'll do that after we agree on the content.

@felixfontein
Copy link
Collaborator

I like the formulation.

Comment on lines 59 to 62
Issues with the ``ansible`` package build process or serious bugs or
vulnerabilities in a collection that are not addressed after opening an issue
in the collection's issue tracker should be reported on
`ansible-build-data's issue tracker <https://github.com/ansible-community/ansible-build-data/issues>`_.

Choose a reason for hiding this comment

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

Should we mention the README here? I'm thinking of something like

For a more detailed overview, refer to the `ansible-build-data's README <https://github.com/ansible-community/ansible-build-data/blob/main/README.md>`_.

I'm not sure, so just commenting and not requesting a change.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds like a good idea, especially if we add ansible-community/ansible-build-data#322.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like the suggestion, but I'm a bit hesitant to make this section longer. I'm open to adding that after ansible-community/ansible-build-data#322 is merged if others feel strongly.

Copy link
Contributor

Choose a reason for hiding this comment

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

why edit anything in 7.x? it's eol and no changes will happen.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@samccann this is a fixure for unit tests. If any older verison is rebuilt, the latest README.rst template has always been used. Simply ignore the filename. (The comment should have been for src/antsibull/data/ansible-readme.rst anyway, since that's the source of truth.)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Comment on lines 59 to 62
Issues with the ``ansible`` package build process or serious bugs or
vulnerabilities in a collection that are not addressed after opening an issue
in the collection's issue tracker should be reported on
`ansible-build-data's issue tracker <https://github.com/ansible-community/ansible-build-data/issues>`_.
Copy link
Contributor

Choose a reason for hiding this comment

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

why edit anything in 7.x? it's eol and no changes will happen.

tests/test_data/package-files/8.1.0/README.rst Outdated Show resolved Hide resolved
Comment on lines 59 to 62
Issues with the ``ansible`` package build process or serious bugs or
vulnerabilities in a collection that are not addressed after opening an issue
in the collection's issue tracker should be reported on
`ansible-build-data's issue tracker <https://github.com/ansible-community/ansible-build-data/issues>`_.

Choose a reason for hiding this comment

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

Should we say at all what kind of issues we accept in ansible-build-data here? Can't we just refer to the README? Something like:

If you think the above issue trackers are the wrong place for your issue, there is also the ansible-build-data's issue tracker <https://github.com/ansible-community/ansible-build-data/issues>_. Please refer to the ansible-build-data's README <https://github.com/ansible-community/ansible-build-data/blob/main/README.md> for more details.

This lacks the information about "serious bugs or vulnerabilities in a collection that are not addressed after opening an issue in the collection's issue tracker", though... but I think we should mention the README somehow here. We have a lot more details about acceptable issues there, far more than we could or should go into here.

Copy link

@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.

LGTM

@felixfontein
Copy link
Collaborator

Can you add a changelog fragment?

@mariolenz
Copy link

Can you add a changelog fragment?

@felixfontein There is a changelog fragment now :-)

@gotmax23 gotmax23 merged commit aa1dadf into ansible-community:main Nov 22, 2023
7 of 8 checks passed
@gotmax23
Copy link
Contributor Author

Thanks everyone!

@gotmax23 gotmax23 added this to the 0.60.0 milestone Nov 22, 2023
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

4 participants