USRSE / USRSE/usrse.github.io

Issue with CircleCI previews

Open
#945 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug hacktoberfest help wanted
Dominant language
HTML
Stars
33
Forks
104
Avg merge
12h 3m
Merged PRs (30d)
10

Description

    > The idea looks good. The links don't work in the preview, but my guess is this is an issue with the preview rather than the site.

I've been noticing this on the last couple of PRs I've made as well.

I think this is partially an issue either with CircleCI itself or the way we have it setup. The artifacts site doesn't seem to be able to handle the URL paths we expect. For example, we expect people to be able to go to https://us-rse.org/events/2022/2022-12-AGM/, but CircleCI seems to need us to add index.html to the end of the link. Oddly, this doesn't seem to always work though. E.g. at least two of the links on the US-RSE landing page don't work after adding the index.html (and fixing the other issue I mention below.)

Also, we may have a problem with the way we use "baseurl" (maybe?), at least in terms of CircleCI. I've noticed just about every link you click on in CircleCI artifacts adds an extra "https://output.circle-artifacts.com/" to the front of the URL, e.g. https://output.circle-artifacts.com/https://output.circle-artifacts.com/output/job/69a12ffd-95a9-4823-9007-26c8df8751a3/artifacts/0/usrse.github.io/working-groups. But if you drop the additional https bit and add index.html, the link works...https://output.circle-artifacts.com/output/job/69a12ffd-95a9-4823-9007-26c8df8751a3/artifacts/0/usrse.github.io/working-groups/index.html.

So with this and the index.html expectation, no links work in the preview correctly. You have to go back to the overarching artifacts page and find the page you want to view.

Originally posted by @exoticDFT in https://github.com/USRSE/usrse.github.io/issues/942#issuecomment-1271823979

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the CircleCI preview artifacts and the site’s baseurl behavior described in the issue, then compare links for nested pages such as /events/2022/2022-12-AGM/ and /working-groups. Reproduce the broken navigation in a preview and determine the configuration or URL handling responsible. Done means preview links resolve directly to the intended pages without manually adding index.html or removing a duplicated artifacts URL.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
ci-cd
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.