Skip to content
This repository has been archived by the owner on Dec 11, 2024. It is now read-only.

(IGNORE) Fix link to nightly build docs in README.md #142

Merged
merged 4 commits into from
Sep 15, 2023
Merged

Conversation

crandmck
Copy link
Collaborator

Changes in this pull request

Unfortunately, the relative link is broken when the doc is rendered on the doc site: https://opensource.contentauthenticity.org/docs/c2patool/#nightly-builds.
Change to absolute URL fixes it.

Also added colon to UTC time, per Adobe style guide.

@codecov-commenter
Copy link

codecov-commenter commented Sep 13, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (4996e42) 83.91% compared to head (091b426) 83.91%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #142   +/-   ##
=======================================
  Coverage   83.91%   83.91%           
=======================================
  Files           3        3           
  Lines         373      373           
=======================================
  Hits          313      313           
  Misses         60       60           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Use relative URL to correctly point to docs tree in branch when relevant.
Copy link
Collaborator

@scouten-adobe scouten-adobe left a comment

Choose a reason for hiding this comment

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

Made a change to the nightly build link to that it points to the NB README file in the current branch instead of hard-coding the path to the main branch. This appears to work as I intended in this PR branch.

If you're OK with the change, 👍 to merge.

@crandmck
Copy link
Collaborator Author

crandmck commented Sep 13, 2023

@scouten-adobe Your change still uses a relative URL. It needs to be an absolute URL for it to work from https://opensource.contentauthenticity.org/docs/c2patool/#nightly-builds which is the whole reason for this PR in the first place.

Also, wouldn't we always want to link to the file in the main branch? The main branch should always have the current/approved documentation; if there's a WIP branch, e.g. for a PR, then the link might temporarily go to the current README.md instead of the one in the branch, but that seems like an edge case that could easily be ignored during PR review.

Also, I don't have the ability to merge a PR in this repo, even if approved. :-(

Copy link
Contributor

@gpeacock gpeacock left a comment

Choose a reason for hiding this comment

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

Ok with me as long as @scouten-adobe approves. I think I heard you discussing this.

@scouten-adobe scouten-adobe merged commit 4375bce into main Sep 15, 2023
@scouten-adobe scouten-adobe deleted the fix-nb-link branch September 15, 2023 22:36
scouten-adobe pushed a commit to contentauth/c2pa-rs that referenced this pull request Dec 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants