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

💥 Update ALL remaining roles to new format (with docs and tests) #655

Merged
merged 85 commits into from
Apr 18, 2023

Conversation

anarion80
Copy link
Contributor

What this PR does / why we need it:

As in the title: I updated all the remaining roles to new format - adding docs and molecule tests. I know this doesn't really adhere to your contributing guideline, but you're probably busy, PR intake is slow, so here it is.

While creating passing tests I had to fix some roles:

  • Krusader had old, non-existent image
  • Nomad needed gpg key update
  • Timemachine needed apt cache update
  • Wallabag needed additional directories created with certain permissions (can be a bug in Wallabag currently)
  • ZNC needed a starting config file as it was interactive and thus not easy to automate testing for

From the general things:

  • Fixed lint
  • Moved from deprecated links to networks for certain roles
  • Added variables for container image names:versions instead of hardcoding in tasks
  • Updated Ansible module names to use fully qualified collection name (FQCN)

All passing tests are here: https://github.com/anarion80/ansible-nas/actions/runs/4392401003

Which issue (if any) this PR fixes:

Fixes #

Any other useful info:

@davestephens
Copy link
Owner

Wow, this is amazing, thank you!

I'll start reviewing this week, hopefully won't take too long to get merged.

Copy link
Owner

@davestephens davestephens left a comment

Choose a reason for hiding this comment

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

This looks great, thank you for taking the time!

Few comments;

  • all of the doc moves have been dragged and dropped rather than git mv ...., which means the files are showing as new additions, and we lose the history.
  • the roles I'd already rejigged are missing the new docker settings - these are a nice addition so would be good to add
  • the docs generation doesn't currently cater for docs within the role directories, so will need some shell scripting to set up (or the docs be left in their original location for now).

@anarion80
Copy link
Contributor Author

all of the doc moves have been dragged and dropped rather than git mv ...., which means the files are showing as new additions, and we lose the history.

Do you mean moves of existing docs from website into roles? If so - yes, I can remove then, do git mv ... and update if necessary.

the roles I'd already rejigged are missing the new docker settings - these are a nice addition so would be good to add

Which setting do you mean exactly?

the docs generation doesn't currently cater for docs within the role directories, so will need some shell scripting to set up (or the docs be left in their original location for now)

Yes, so the docs are left in their original settings (when I add new roles for myself I add docs to both locations for now), and in new roles location - just to be consistent with hello_world example and ready for any future script updates.

@anarion80
Copy link
Contributor Author

anarion80 commented Mar 21, 2023

Ok, I think it should be rather git cp .. still, not mv, since I just followed to convention and did not attempt to MOVE all the docs storing and generation to /docs folders. For now at least.

…story in roles/transmission-with-openvpn/docs/ history.
…d history in roles/woodpecker-ci/docs/ history.
…md history in roles/youtubedlmaterial/docs/ history.
@anarion80
Copy link
Contributor Author

anarion80 commented Mar 28, 2023

Well, I copied the files using git-cp which was supposed to copy git history, but I don't see that git history :/

@viktor-c viktor-c mentioned this pull request Apr 1, 2023
@davestephens
Copy link
Owner

Well, I copied the files using git-cp which was supposed to copy git history, but I don't see that git history :/

Ah, that makes sense why they are showing as new files. I think it'll end up as a management nightmare having two copies of the docs - so please can we remove the new copies and leave the docs where they were originally. Once I get to sorting out the docs generation I can move them into the roles again!

@anarion80
Copy link
Contributor Author

Ok, I removed the new/individual docs, and also rebased to upstream

@davestephens davestephens merged commit 6b697c7 into davestephens:master Apr 18, 2023
@davestephens
Copy link
Owner

Finally got this one merged - thanks for your efforts - I also did a fair bit of extra work on it :)

Also - the following tests aren't passing:

FAILED roles/joomla/molecule/default/molecule.yml::test
FAILED roles/nextcloud/molecule/default/molecule.yml::test
FAILED roles/openhab/molecule/default/molecule.yml::test
FAILED roles/piwigo/molecule/default/molecule.yml::test
FAILED roles/transmission-with-openvpn/molecule/default/molecule.yml::test
FAILED roles/virtual_desktop/molecule/default/molecule.yml::test

It seems that they are all roles that have been flipped to creating a network over the legacy link method. Did you see this in testing?

@anarion80
Copy link
Contributor Author

Thanks! Yes, I fillpped them over to the new method over deprecated link method.
I quickly checked the first two roles on new_format branch and they are passing tests all right.
I will rebase my master and check there.

@davestephens
Copy link
Owner

davestephens commented Apr 19, 2023 via email

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.

2 participants