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

prepare 1.15.0 release #1062

Merged
merged 1 commit into from
Oct 5, 2021
Merged

prepare 1.15.0 release #1062

merged 1 commit into from
Oct 5, 2021

Conversation

mariolenz
Copy link
Collaborator

@mariolenz mariolenz commented Oct 1, 2021 •
edited by goneri
Loading

Depends-On: #1063

New minor release, 1.15.0.

ansible-playbook tools/prepare_release.yml

@ansibullbot ansibullbot added community_review docs needs_triage Needs a first human triage before being processed. labels Oct 1, 2021
@ansibullbot
Copy link

@mariolenz This PR was evaluated as a potentially problematic PR for the following reasons:

  • More than 50 changed files.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on irc.freenode.net

click here for bot help

@ansibullbot ansibullbot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Oct 1, 2021
@mariolenz
Copy link
Collaborator Author

@Akasurde @goneri Damn, it looks like tools/prepare_release.yml doesn't really work as expected. #1024 wanted to change more than 170 files iirc. I said we could update the documentation when releasing the next version. But running tools/prepare_release.yml only changed some 40 files.

The playbook follows the process described here, but the module documentation doesn't show All modules requires API write access and hence is not supported on a free ESXi license from plugins/doc_fragments/vmware.py.

@ansibullbot ansibullbot removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Oct 1, 2021
@mariolenz mariolenz changed the title prepare 1.15.0 release [WIP] prepare 1.15.0 release Oct 2, 2021
@mariolenz mariolenz added the WIP Work in progress label Oct 2, 2021
@mariolenz
Copy link
Collaborator Author

@Akasurde @goneri Sorry, but I'm unable to properly update the plugin docs. Neither tox -e add_docs nor using collection_prep_add_docs -p . seems to add the note that API write access is required from plugins/doc_fragments/vmware.py.

What am I doing wrong?

@ansibullbot
Copy link

@mariolenz this PR contains the following merge commits:

Please rebase your branch to remove these commits.

click here for bot help

@ansibullbot ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Oct 4, 2021
@mariolenz
Copy link
Collaborator Author

@Akasurde How did you update the plugin docs? As I've said, tox -e add_docs didn't work for me.

@Akasurde
Copy link
Member

Akasurde commented Oct 4, 2021

I used collection_prep_add_docs -p .

@mariolenz
Copy link
Collaborator Author

mariolenz commented Oct 4, 2021 •
edited
Loading

I used collection_prep_add_docs -p .

Strange. I've tried both ways, tox and collectio_prep_add_docs but neither worked for me.

Well, thanks for updating the docs. I'll remove the WIP label now.

@mariolenz mariolenz changed the title [WIP] prepare 1.15.0 release prepare 1.15.0 release Oct 4, 2021
@mariolenz mariolenz requested a review from goneri October 4, 2021 11:23
@ansibullbot ansibullbot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed WIP Work in progress community_review labels Oct 4, 2021
@mariolenz mariolenz mentioned this pull request Oct 4, 2021
Open
@mariolenz
Copy link
Collaborator Author

@Akasurde @goneri I think I know now what I did wrong! I've just cloned the repo to some place. After I've cloned it to ~/.ansible/collections/ansible_collections/community/vmware, tox -e add_docs suddenly changed 170+ files instead of just 38 or so! So it looks like collection_prep_add_docs -p $DIR doesn't search for plugins/doc_fragments in $DIR but in the collection search path.

OK, good to know. Maybe we should document this.

Although I would consider this a workaround. I somehow think that updating the documentation for plugins/modules in the directory given by -p, but using plugins/doc_fragments from the collection search path is a bit weird... if not to say: inconsistent. I think the real solution would be to change the behavior of collection_prep_add_docs.

I've opened ansible-network/collection_prep#67 for this, let's see what they'll say.

@mariolenz mariolenz removed the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Oct 5, 2021
@ansibullbot ansibullbot added community_review needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html and removed merge_commit This PR contains at least one merge commit. Please resolve! labels Oct 5, 2021
@mariolenz
Copy link
Collaborator Author

@Akasurde @goneri ansibullbot added the needs_rebase tag, but I don't really understand why. Instead of rebasing, I've updated my main branch and re-created the new release with ansible-playbook tools/prepare_release.yml.

Now that I know I have to run this in ~/.ansible/collections/ansible_collections/community/vmware all plugin documentation has been updated as expected :-)=)

@goneri goneri added the gate label Oct 5, 2021
@goneri
Copy link
Member

goneri commented Oct 5, 2021

Thank you @mariolenz

ansible-zuul[bot]
ansible-zuul bot approved these changes Oct 5, 2021
View reviewed changes
Copy link
Contributor

@ansible-zuul ansible-zuul bot left a comment

Choose a reason for hiding this comment

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

LGTM!

@ansible-zuul ansible-zuul bot merged commit 5280ccf into ansible-collections:main Oct 5, 2021
@mariolenz mariolenz deleted the prepare_1.15.0_release branch October 5, 2021 17:07
@mariolenz mariolenz mentioned this pull request Oct 5, 2021
Merged
@mariolenz
Copy link
Collaborator Author

@goneri It looks like changelogs/fragments hasn't been cleaned. Somehow, this didn't work:

community.vmware/tools/prepare_release.yml

Lines 23 to 26 in 5280ccf

- name: Clean up the changelog fragments
ansible.builtin.file:
path: changelogs/fragments
state: absent

I've issued PR #1068 and will work on this.

ansible-zuul bot pushed a commit that referenced this pull request Oct 8, 2021
@mariolenz
Clean up changelogs/fragments/ (#1068)
5b6462a 
Clean up changelogs/fragments/

Depends-On: ansible/ansible-zuul-jobs#1172
Depends-On: ansible/ansible-zuul-jobs#1169
Depends-On: ansible/ansible-zuul-jobs#1171
Depends-On: #1072
#1062 didn't clean up changelogs/fragments/so I'll do this manually. For now, Id like to do this manually and work on a fix later. I already have an idea...

Reviewed-by: Gonéri Le Bouder <goneri@lebouder.net>
Reviewed-by: None <None>
Reviewed-by: Abhijeet Kasurde <None>
@mariolenz mariolenz mentioned this pull request Nov 5, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ansible-zuul ansible-zuul[bot] ansible-zuul[bot] approved these changes

@goneri goneri Awaiting requested review from goneri

Assignees
No one assigned
Labels
community_review docs needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR needs_triage Needs a first human triage before being processed.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mariolenz @ansibullbot @Akasurde @goneri