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

generated from is not linking to the reflog #145

Closed
finanalyst opened this issue Feb 26, 2023 · 10 comments
Closed

generated from is not linking to the reflog #145

finanalyst opened this issue Feb 26, 2023 · 10 comments
Assignees
Labels
bug Something isn't working

Comments

@finanalyst
Copy link
Collaborator

The link in the 'generated from' in the footer is 404'ing.
There should be a reflog value that is concatenated onto the github/Raku/doc/tree path
Something is not quite working in the build environment,
The plugin is Website/plugins/git-reflog

@finanalyst finanalyst added the bug Something isn't working label Feb 26, 2023
@finanalyst finanalyst added this to the 2023-Quarter 1 milestone Feb 26, 2023
@finanalyst finanalyst self-assigned this Feb 26, 2023
@coke
Copy link
Contributor

coke commented Feb 27, 2023

If the commit id isn't available, the URL can be shortened to https://github.com/Raku/doc/

so at least we can point the user back at the git repo.

@finanalyst
Copy link
Collaborator Author

@coke I'm working on why the commit bit is not available. It should be.

@finanalyst
Copy link
Collaborator Author

@dontlaugh I do not know how to debug this problem. When I clone 'doc-website' and do a fresh build, the git-reflog is correctly obtained from the clone of Raku/docs/doc repo. So something is not quite working in your build environment, but I don't know how to replicate it.

The raku program responsible for getting the reflog does this

my $rep = $source-root.IO.parent;
my $proc = run <<git -C $rep rev-parse --short HEAD>>, :out;
my $reflog = $proc.out.slurp(:close).chomp;

$source-root is provided by Collection and may not be correctly accessed for some reason in the build environment. I wonder whether this may be a permissions problem. Does the user-id running build-site have permission to run git -C <path to repo> rev-parse --short HEAD?

@dontlaugh
Copy link
Collaborator

dontlaugh commented Feb 27, 2023

Where/how is $source-root set?

Update: I see, it's a "plugin".

If this is something you need. Make the plugin fail the build if it generates invalid output. Force the issue.

@finanalyst
Copy link
Collaborator Author

@dontlaugh It is a parameter passed by Collection to setup callables.
The relevant file is Website/plugins/git-reflog/add-ref-hash.raku.

@finanalyst
Copy link
Collaborator Author

finanalyst commented Feb 27, 2023

@dontlaugh

Make the plugin fail the build if it generates invalid output. Force the issue.

I can do a PR for doc-website that would force the issue. But will that affect the next production build?

@dontlaugh
Copy link
Collaborator

Nothing will make it to production until the issue is fixed. That's why it's good to fail the build if we're missing something. In general, do that for everything that isn't correct.

I'll work on making the build logs public to make this easier for us to debug. Just need to make sure no secret values are exposed.

@finanalyst
Copy link
Collaborator Author

@dontlaugh That sounds good. Just to be clear:

  • I can create a PR to doc-website and merge to main.
  • Wait for an hour to see how the change pans out on dev-doc.raku.org
  • Iterate until happy.
  • Notify you when doc-website main is stable again?

If this is true, is there a way to trigger the rebuild of dev-docs.raku.org or is it triggered by a push to main.

@finanalyst
Copy link
Collaborator Author

The git-reflog plugin is causing errors elsewhere.
This needs more investigation, so I am disabling the plugin.
There should be no adverse effect elsewhere.

@finanalyst
Copy link
Collaborator Author

issue now moot as functionality removed. Closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants