Why does plone/documentation keep getting committed automatically?

Question

Why does plone/documentation keep getting committed automatically?

Closed this issue 3 years ago · 23 comments

stevepiercy commented 3 years ago

I keep breaking Jenkins with ever merge commit to the 6-dev branch in plone/documentation. Help! Make it stop!

This file keeps getting updated:

https://github.com/plone/buildout.coredev/blob/6.0/checkouts.cfg

Example automatic commit:

75b42d6

Answer 1 · 2022-01-24T10:54:42.000Z

As mentioned elsewhere this can be mitigated by adding:

documentation                          = git ${remotes:plone}/documentation.git pushurl=${remotes:plone_push}/documentation.git egg=false branch=6-dev path=${buildout:docs-directory}

But probably removing this hook might help.

Answer 2 · 2022-01-24T10:55:29.000Z

I will try to fix the sources right now and investigate more on this later CC @plone/testing-team

Answer 3 · 2022-01-24T10:56:37.000Z

🤔 I think is a mr.roboto feature, if a package that is listed in sources gets a new change but is not on checkouts, it adds it, so one can ensure that the new features that landed on a package get tested

Answer 4 · 2022-01-24T10:57:04.000Z

We can add an exception list on that functionality (if it actually works as I mentioned, which my not even be true 😅 )

Answer 5 · 2022-01-24T10:57:30.000Z

I do not know why it was added or whether it should be preserved in some way.

I now have access to the plone/documentation repo settings, too.

Answer 6 · 2022-01-24T11:00:14.000Z

Also this is not urgent from my perspective or from that of the branch 6-dev in Plone Docs. Take your time. I just don't want to keep breaking Jenkins builds!

Answer 7 · 2022-01-24T11:00:42.000Z

Indeed, there is such a functionality: https://github.com/plone/mr.roboto/blob/70e08fcab664a8db4e0749b92c6acca62288d46d/src/mr.roboto/src/mr/roboto/subscriber.py#L473

Answer 8 · 2022-01-24T11:01:13.000Z

@gforcada I think you got it right but in the sources.cfg the repo is defined as:

docs                          = git ${remotes:plone}/documentation.git pushurl=${remotes:plone_push}/documentation.git egg=false branch=6-dev path=${buildout:docs-directory}

In #769 I provide an alias for that.
Maybe we should just switch docs to documentation, but I am afraid of implications I cannot see right now

Answer 9 · 2022-01-24T11:05:43.000Z

the question is, why is documentation on the checkouts? and if anyway it has to stay there, it does at least not have to make jenkins run again, right? 🤔 so we can add an exception list on the function on mr.roboto or even remove the hooks for mr.roboto on the documentation repo itself... either of the two will fix this problem

Answer 10 · 2022-01-24T11:05:45.000Z

I think that somewhere here we could make some check that excludes the documentation repo: https://github.com/plone/mr.roboto/blob/70e08fcab664a8db4e0749b92c6acca62288d46d/src/mr.roboto/src/mr/roboto/subscriber.py#L459-L469

Answer 11 · 2022-01-24T11:06:33.000Z

sure, why is it though that the documentation is checked alongside the code? 🤔

Answer 12 · 2022-01-24T11:06:37.000Z

I have time to do that now, if somebody wants to join me on that, please ping me in discord

Answer 13 · 2022-01-24T11:09:59.000Z

sure, why is it though that the documentation is checked alongside the code? thinking

Maybe it is needed for some other automation, IMO it is not that bad to have that in the sources.cfg.

Answer 14 · 2022-01-24T11:10:44.000Z

@ale-rt if you can review this: plone/mr.roboto#91 👍🏾

Answer 15 · 2022-01-24T11:53:24.000Z

@gforcada, PR approved, in the meanwhile I removed the unwanted checkout to restore the build.

Also, #769 seems to be a workaround, but I will close it since plone/mr.roboto#91 fixes the root cause of the issue.

Answer 16 · 2022-01-24T21:44:33.000Z

Deployed to production, can someone test if my fix does work? 😄

Answer 17 · 2022-01-24T21:57:03.000Z

We have a few WIP PRs. I'll let you know whether I get another alert after we merge the next one.

Answer 18 · 2022-02-03T12:44:47.000Z

@gforcada PR #1160 merged. 🤞

Answer 19 · 2022-02-03T12:46:15.000Z

I think it worked. This file was not updated. https://github.com/plone/buildout.coredev/blob/6.0/checkouts.cfg Is that what y'all were expecting?

Answer 20 · 2022-02-03T12:47:53.000Z

Not sure what to make of this email. Is it still a problem?

POSSIBLE CHECKOUT ERROR plone/documentation 6-dev

Repository: plone/documentation
Author: stevepiercy &lt;web@stevepiercy.com&gt;
Plone Version: 6.0

This package is used by Plone coredev 6.0 branch,
but it’s not currently checked out so is not including
your change for testing.

If you were merging a pull request,
worry not mr.roboto took care of it already,
still double check checkouts.cfg:

https://github.com/plone/buildout.coredev/blob/6.0/checkouts.cfg

On the other hand, if you made a direct commit to a branch,
add the package to checkouts.cfg (above link) please.

Regards,
mr.roboto

Answer 21 · 2022-02-03T23:37:33.000Z

That's a safe check to ensure that if something goes wrong you get a heads up about it

Answer 22 · 2022-02-03T23:41:18.000Z

Sorry for being ignorant. I'm new to this repo.

I don't know what is "expected". How do I know what is "something goes wrong"?

Answer 23 · 2022-02-03T23:47:51.000Z

i.e. regular Plone packages are expected to be in a certain buildout.coredev branch, if a package is not check out it might miss the new changes being tested