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 main! #86

Merged
merged 195 commits into from
Jun 7, 2024
Merged

update main! #86

merged 195 commits into from
Jun 7, 2024

Conversation

CeresBarros
Copy link
Member

It's time :P

@achubaty, I've removed development from teh GHA workflow, because it keeps creating html/md files that conflict with the main branch on every push during a PR.

Perhaps this is not ideal, but the manual is not a true test either and it gets rebuild on push to main anyways (when PR is merged)

@achubaty
Copy link
Collaborator

achubaty commented Jun 7, 2024

Hmm, I don't think that's a good workflow. Those are super easy conflicts to resolve: take the devel version of those files.

If main is regularly updated AND the documentation is kept up to date during devel (and tested locally!), it may not make a real practical difference... but we know that devel docs aren't regularly maintained, and if they aren't built locally and problems fixed, then we won't see issues for weeks/months until the next merge to main.

@CeresBarros
Copy link
Member Author

take the devel version of those files.

Sure. It's just that I found my self doing that like 10 times today, lol. And what was happening was, if I took the devel versions there would be "nothing to merge" and the conflict would't be "resolved".
How are you dealing with that?

@achubaty
Copy link
Collaborator

achubaty commented Jun 7, 2024

You can also rebuild the docs locally and use the new files (taking neither the main nor devel versions).

@CeresBarros
Copy link
Member Author

I don't think that doesn't work either because (assuming there's a PR devl -> main)

  1. you render/build locally on devel
  2. you commit and push
  3. GHA is triggered and builds the files again
  4. the conflict between devel and main wrt those files is still there and reported in the PR

@CeresBarros
Copy link
Member Author

CeresBarros commented Jun 7, 2024

The "only" way I found to "remove" the conflict was to:
locally merge main -> devel, take at least one of the files (e.g. the HTML) and push that merged commit to devel, then accept PR. But I think eventually, once GHA rebuilds the HTML on devel, the conflict comes back if the PR is not merged beforehand

@CeresBarros CeresBarros merged commit 576d75a into main Jun 7, 2024
2 checks passed
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.

4 participants