Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 5.53 KB

ERROR-MODES.md

File metadata and controls

99 lines (61 loc) · 5.53 KB

OpenID Foundation publication actions - Dealing with Errors

FAIL: No HTML files have changed. Exiting script

The branch being processed does not have any updated HTML files for the checks to run against

ACTION TO FIX: Add one or more HTML files with specification content in them

FAIL: More than one WG sub-directory updated

HTML files have been updated in more than one Working Group Sub-directory. Proposed specs in a branch should only be submitted from one Working Group.

ACTION TO FIX: split the proposed publications into seperate branches for each Working Group

FAIL: File {file} already exists

The HTML: file submitted has the same name as a file that has been published to the https:/openid.net/specs directory on a previous occasion

ACTION TO FIX: Change the filename of the HTML document to the next draft increment number

FAIL: Either Markdown or XML Source is required

The source of the HTML document must be submitted with the HTML file and that source can either be a ".md" or ".xml"

ACTION TO FIX: Add source files of either Markdown or XML with the correct filename suffix and a filename prefix that is the same as the proposed HTML file

FAIL: Problem with document titles so state is UNKNOWN

OR - FAIL: Unexpected document state: {state}

ACTION TO FIX This tool analyses the "title" inside the HTML document to determine what type or proposal the document submission is. It could be "draft", "final" or "errata". The tool has failed to detect this type based on the HTML file content.

ACTION TO FIX: The document title should contain one of the following:

  • "document name - draft 01" - note the draft number
  • "document name - final"
  • "document name - errata"

Check that both the "<title>" tag and the "<h1 id="title">" has the correct content and that the two are the same. This content should originate from the same element in the source Markdown or XML.

FAIL: DRAFT state but does not have required history section

When the document is in a DRAFT state it must have the history section

ACTION TO FIX: add a history section or change the heading to change the state of the document to Final or Errata if that is what is intended

FAIL: FINAL state but history section exists

When the document is in a FINAL state it must not have the history section

ACTION TO FIX: delete the history section or change the heading to change the state of the document to Draft if that is what is intended

FAIL: ERRATA state but history section exists

When the document is in a ERRATA state it must not have the history section

ACTION TO FIX: delete the history section or change the heading to change the state of the document to Draft if that is what is intended

FAIL: A predecessor final spec does not exist

When the document is in a ERRATA state it there must be a FINAL spec published that was previously published with the same name

ACTION TO FIX: Either change the document state to FINAL by adjusting the title if there is no pre-existing FINAL spec or correct the filename to match the previously published final spec

FAIL: Problem with authors in {file}

The Authors section needs to exist and contain at least one author name and the affiliation of all authors

ACTION TO FIX: Check that the authors section exists and has rendered correctly in the HTML

FAIL: Problem with Notices section in {file}

The Notices section needs to exist and contain the current year and specific text defined in the OIDF IPR document

ACTION TO FIX: ensure that the Notices section exists and that it contains the right text

FAIL: Problem with References in {file}

The References section is checked to ensure that all links referenced are reachable over rthe internet.

Known Defect: A small number of valid resources that are references do not respond to a HEAD method request with a 200 code. These will fail even though there is a successfule response to a GET request

ACTION TO FIX: Double check the references to ensure that they are all reachable and highlight to secretary team if there is an issue with response to HEAD requests

FAIL: Problem with structure in {file}

If any of the following sections are not present there will be a failure:

  • Abstract
  • Introduction
  • Normative References
  • Informative References
  • Acknowledgements
  • Security Considerations

ACTION TO FIX: Identify which section is missing and ensure it is present in the document

FAIL: FAIL: Publication date is more than 10 days ago in {file}

Documents should be published soon after the last revision and this tool reports a FAIL if the detected date is more than 10 days before the checks are executed.

ACTION TO FIX: Re build the document with a recent publication date (within last 10 days)

FAIL: {file} did not pass all checks

This is simply a reflection that one or more mandatory checks have failed

ACTION TO FIX: Determine which of the other checks have failed and address those

Any other errors or errors you are struggling to resolve:

Contact the Technical Director, Operations Director or Secretary of the OIDF