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.

Sign up for GitHub

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

Jump to bottom

docs: Add more information about running integration tests #1278

Merged
merged 5 commits into from
Nov 29, 2022
Merged

docs: Add more information about running integration tests #1278

merged 5 commits into from
Nov 29, 2022
+86 −31

Conversation

mdavis-xyz
Copy link
Contributor

@mdavis-xyz mdavis-xyz commented Nov 18, 2022 •
edited by tremble
Loading

SUMMARY

Adds content to CONTRIBUTING.md,
and rearranges some red-herring links.

Fixes: #924

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

CONTRIBUTING.md

ADDITIONAL INFORMATION

@mdavis-xyz
docs: Add more information about running integration tests

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
b08d98b
@mdavis-xyz
Copy link
Contributor Author

Note that we'll probably want to copy-paste the same changes into community.aws.

@mdavis-xyz
Copy link
Contributor Author

Note that I wasn't sure what type of change to put in the changelog. I couldn't see a docs option here.

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 09s
✔️ build-ansible-collection SUCCESS in 5m 12s
❌ ansible-test-sanity-aws-ansible-python38 FAILURE in 8m 47s (non-voting)
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 9m 18s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 9m 34s
✔️ ansible-test-sanity-aws-ansible-2.14 SUCCESS in 8m 47s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 7m 50s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 51s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 45s
✔️ cloud-tox-py3 SUCCESS in 3m 17s

tremble
tremble reviewed Nov 18, 2022
View reviewed changes
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to open this PR, new contributors are often some of the best folks to help with the 'getting started' docs.

I think these changes are a significant improvement. But I'd like some additional input from the others.

@tremble
Copy link
Contributor

tremble commented Nov 18, 2022

Note that I wasn't sure what type of change to put in the changelog. I couldn't see a docs option here.

We often use trivial, which is for anything which doesn't really need to be visible in the release notes:

You can also use trivial for any collection that requires a changelog fragment for each pull request. trivial changelog fragments are excluded from the changelog output.

Not adding a changelog entry is one of the most common, easily fixable, issues we encounter during reviews, which is why there's now a test for it. The test could be more intelligent, but docs/test only PRs are relatively rare, and in the case of non-module plugins (inventory plugins, lookup plugins, etc), the docs fragments are actually parsed and used to automatically configure the argument_spec for the plugins.

@ansibullbot ansibullbot removed the new_contributor Help guide this first time contributor label Nov 18, 2022
@github-actions
Copy link

github-actions bot commented Nov 28, 2022 •
edited
Loading

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 5m 10s
✔️ build-ansible-collection SUCCESS in 5m 52s
❌ ansible-test-sanity-aws-ansible-python38 FAILURE in 9m 36s (non-voting)
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 9m 20s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 8m 56s
✔️ ansible-test-sanity-aws-ansible-2.14 SUCCESS in 9m 33s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 7m 18s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 10s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 08s
✔️ cloud-tox-py3 SUCCESS in 3m 17s

tremble
tremble requested changes Nov 28, 2022
View reviewed changes
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

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

This is a significant improvement to CONTRIBUTING.md, thankyou for taking the time. My only remaining concern is making sure that the README.md change doesn't break something.

If you're not comfortable making the extra-docs.yml / docs/docsite/rst changes what we could do is remove the README.md change from this PR so we can get it merged and I'll line up something to tweak README.md and the other docsite changes.

@mdavis-xyz
Copy link
Contributor Author

I feel like linking from the README to CONTRIBUTING is one of the most important changes in this PR. I didn't even notice that the file CONTRIBUTING.md existed when I was trying to figure out how to contribute.

I've tried to make those changes now. I don't know whether the fact that this is .md not .rst will break anything, compared to the changelog.

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 31s
✔️ build-ansible-collection SUCCESS in 5m 45s
❌ ansible-test-sanity-aws-ansible-python38 FAILURE in 9m 05s (non-voting)
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 8m 44s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 9m 37s
✔️ ansible-test-sanity-aws-ansible-2.14 SUCCESS in 8m 47s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 6m 08s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 33s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 8m 19s
✔️ cloud-tox-py3 SUCCESS in 3m 17s

tremble
tremble approved these changes Nov 29, 2022
View reviewed changes
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

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

Ok, looks like your original idea of linking direct to CONTRIBUTING.md is what we'll have to go with for now. Many thanks for these changes.

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 12s
✔️ build-ansible-collection SUCCESS in 5m 56s
❌ ansible-test-sanity-aws-ansible-python38 FAILURE in 8m 41s (non-voting)
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 8m 44s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 12m 03s
✔️ ansible-test-sanity-aws-ansible-2.14 SUCCESS in 8m 20s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 5m 59s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 53s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 55s
✔️ cloud-tox-py3 SUCCESS in 3m 12s

@tremble
Copy link
Contributor

tremble commented Nov 29, 2022

@alinabuzachis I think these changes are very positive, any objections to merging them?

@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label Nov 29, 2022
@tremble
Copy link
Contributor

tremble commented Nov 29, 2022

Thanks @mdavis-xyz

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).

✔️ ansible-galaxy-importer SUCCESS in 4m 14s
✔️ build-ansible-collection SUCCESS in 5m 32s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit bb03237 into ansible-collections:main Nov 29, 2022
@mdavis-xyz mdavis-xyz mentioned this pull request Nov 29, 2022
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samccann samccann

@tremble tremble

@alinabuzachis alinabuzachis

Assignees
No one assigned
Labels
community_review docs mergeit Merge the PR (SoftwareFactory) needs_triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to run integration tests more clearly
5 participants
@mdavis-xyz @tremble @samccann @alinabuzachis @ansibullbot