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

Fix up event ref for deletion of docs associated with deleted branch #216

Merged
merged 1 commit into from
Jan 18, 2024

Conversation

SorenSpicknall
Copy link
Contributor

@SorenSpicknall SorenSpicknall commented Jan 18, 2024

Pull Request

Changes the branch lineage referenced in clean-docs.yml so that older docs versions associated with a branch's deletion event are targeted correctly for deletion, rather than the docs associated with the head branch after that event has happened. This is a follow-up to #215.

The event trigger behavior and the resulting branch ref was tested on a private repo before creating this PR.

@SorenSpicknall SorenSpicknall requested a review from a team as a code owner January 18, 2024 20:58
Copy link
Contributor

@e-lo
Copy link
Contributor

e-lo commented Jan 18, 2024

Ahhh - event.ref instead of ref :-) let's see how this goes...

@e-lo e-lo self-requested a review January 18, 2024 22:24
Copy link
Contributor

@e-lo e-lo left a comment

Choose a reason for hiding this comment

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

lets see what happens.... 🤞

@e-lo e-lo merged commit b4d722c into main Jan 18, 2024
5 checks passed
@e-lo e-lo deleted the soren-fixup_branch_ref_for_docs_deletion branch January 18, 2024 22:25
@e-lo
Copy link
Contributor

e-lo commented Jan 18, 2024

no go :-(
image

@SorenSpicknall
Copy link
Contributor Author

This is progress. It's targeting the right branch for docs deletion now, and the remaining error is a different issue (probably just a bad state in the gh-pages branch). I'll get some time to look at that later today.

@SorenSpicknall
Copy link
Contributor Author

SorenSpicknall commented Jan 19, 2024

Because of incomplete/buggy past firing of documentation-related CI tasks, the gh-pages branch was in an unworkable state to be interacted with by the cleaning workflow. I deleted the branch and recreated it fresh from main.

@e-lo, it appears that the deletion automatically reset the branch source for docs publication. I don't have direct access to the settings needed to set that source again. Can you do the following for me?

  1. Go to the repo Settings page
  2. Click on the "Pages" section in the sidebar
  3. Under "Build and deployment - Source - Deploy from a branch", select the gh-pages branch as the publishing source

Let me know when that's done, and I'll continue some testing.

@e-lo
Copy link
Contributor

e-lo commented Jan 19, 2024

Bad state 🤔 very interesting...

Did what you asked:

image

@SorenSpicknall
Copy link
Contributor Author

SorenSpicknall commented Jan 19, 2024

I'm guessing we also need to point the source at /docs instead of at the root folder of the repository. Can you do that?

@e-lo
Copy link
Contributor

e-lo commented Jan 19, 2024

It should build to root not docs...i thought? I just switched to docs to see.

@SorenSpicknall
Copy link
Contributor Author

SorenSpicknall commented Jan 19, 2024

That was speculative - looking closer, it looks like top-level should be correct since we've got mkdocs.yml and main.py at the top level. I wasn't around when this was configured, so my apologies that I didn't inspect the setup closely enough when firing off that suggestion.

I think we've possibly done conflicting things while both trying to remedy this simultaneously, which is part of why the docs site isn't yet up. If we switch the source ref back to the root folder, and then run the full pages build and deployment process, hopefully that'll bring us back to where we should be.

@SorenSpicknall
Copy link
Contributor Author

Katrina switched the ref back this morning. I'll continue to test and keep you posted!

@SorenSpicknall
Copy link
Contributor Author

SorenSpicknall commented Jan 22, 2024

@e-lo, I've confirmed that the deletion workflow now functions correctly, and that the docs section creation process also works upon a new PR from a repo branch - I triggered the creation action anew on #212 and #214 by making small copy changes to those PRs.

I believe the only remaining current need is to reset the default version used by Mike to redirect people who visit the root of https://tides-transit.github.io/ (or https://tides-transit.org/) to the proper version of the docs. I wasn't sure what was used as a default before, so I didn't set one unilaterally. Currently, all active repo branches are present in the Mike selector (i.e. built in the gh-pages branch), in addition to a version of the docs corresponding to the v1.0-beta.1 tag. Let me know if you need any support setting the default to whatever is appropriate!

@e-lo
Copy link
Contributor

e-lo commented Jan 23, 2024

fixed!

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