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

report_results.csh: add html anchors to hashes and machines #388

Merged
merged 1 commit into from
Dec 19, 2019

Conversation

phil-blain
Copy link
Member

PR checklist

  • Short (1 sentence) summary of your PR
    Add html anchors to hashes and machines in the Test-Results wiki
  • Developer(s :
    Philippe Blain
  • Suggest PR reviewers from list in the column to the right @apcraig
  • Please copy the PR test results link or provide a summary of testing completed below.
    No tests ;)
  • How much do the PR code changes differ from the unmodified code?
    • bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on Icepack or any other models?
    • Yes
    • No
  • Does this PR add any new test cases?
    • Yes
    • No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/. A test build of the technical docs will be performed as part of the PR testing.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

The hashes and machine names inserted by the script in the different pages
of the Test-Results wiki are formatted as bold (** ${hash} **:).

Change this to level 4 HTML titles (<h4>) so that an HTML anchor is
automatically created, which makes it easier to link directly to specific
hash from a pull request.

@phil-blain
Copy link
Member Author

xref: Icepack PR with the same changes: CICE-Consortium/Icepack#290

@phil-blain
Copy link
Member Author

Note: I tried to find where in the script are the pages for the specific releases (ex. https://github.com/CICE-Consortium/Test-Results/wiki/Icepack1.1.2) generated but could find it...

@apcraig
Copy link
Contributor

apcraig commented Dec 9, 2019

Test Results for releases are created manually by copying and pasting the appropriate hash out of the master results and manually creating a wiki page for it. These changes should make it into the release pages as a result.

I think introducing links is not a bad idea, especially for the hash, just a little unclear what is happening with this PR. Are the links created automatically because of github awareness of hashes (not sure about machines)?

@phil-blain
Copy link
Member Author

So basically I changed the markdown syntax from bold to h4. So any new test result generated after these PR are merged will get links. Any new hashes/machine names currently on the wiki would need to be updated manually (or by cloning the wiki and using sed or such).

The hashes and machine names inserted by the script in the different pages
of the Test-Results wiki are formatted as bold (`** ${hash} **:`).

Change this to level 4 HTML titles (<h4>) so that an HTML anchor is
automatically created, which makes it easier to link directly to specific
hash from a pull request.
@phil-blain
Copy link
Member Author

I changed all instances of \*\* to ####
(I had forgotten 2 on the first force-push).

Copy link
Contributor

@apcraig apcraig left a comment

Choose a reason for hiding this comment

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

I tested this and all looks good. Thanks!

@apcraig apcraig merged commit 3e5f693 into CICE-Consortium:master Dec 19, 2019
@phil-blain phil-blain deleted the tests-wiki-add-anchors branch February 12, 2020 15:07
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