Skip to content

Commit

Permalink
Update readme and config issue creation
Browse files Browse the repository at this point in the history
  • Loading branch information
GoetzGoerisch authored and randy-armstrong committed Nov 26, 2020
1 parent ba15588 commit 60e66b4
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 15 deletions.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: OPC-Foundation Issue Tracking
url: https://opcfoundation.org/resources/issue-tracking/
about: Please report issues here.
37 changes: 22 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
<!-- index -->
## OPC UA NodeSets and Other Supporting Files ##
### Contents ###
* [Files Found Here](#files)
* [Release Process](#release)
# OPC UA NodeSets and Other Supporting Files

## Contents

* [Files Found Here](#files-found-here)
* [Release Process](#release-process)
* [Error reporting](#error-reporting)

## Files Found Here

### <a name="files">Files Found Here ###
This repository contains UANodeSets and other normative files which are released with a specification.
Any change to a specification (release of a new version or errata) may require a change to the files in this repository.

For each specification the following normative files need to be published:

* .NodeSet2.xml - The formal definition of the Nodes defined by the specification;
* .Types.xsd - The XML schema for the DataTypes defined by the specification;
* .Types.bsd - The OPC Binary schema for the DataTypes defined by the specification (obsolete);
* .NodeIds.csv - A CSV file containing the NodeIds assigned to Nodes defined by the specification;

In addition, the following non-normative support files may be published:

* .Classes.cs - C# classes for Nodes used with the [.NETStandard](https://github.com/OPCFoundation/UA-.NETStandard) stack;
* .DataTypes.cs - C# classes for DataTypes used with the [.NETStandard](https://github.com/OPCFoundation/UA-.NETStandard) stack;
* .Constants.cs - C# constant declarations used with the [.NETStandard](https://github.com/OPCFoundation/UA-.NETStandard) stack;
* .PredefinedNodes.uanodes - A non-normative binary representation of the UANodeSet for use with [.NETStandard](https://github.com/OPCFoundation/UA-.NETStandard) stack;

If a companion specification working group uses the ModelCompiler to create the UANodeSet then the following files are published:

* .Model.xml - The Nodes defined by the specification using the [schema](https://github.com/OPCFoundation/UA-ModelCompiler/blob/master/ModelCompiler/UA%20Model%20Design.xsd) needed by the [ModelCompiler](https://github.com/OPCFoundation/UA-ModelCompiler);
* .Model.csv - The NodeIds assigned to the Nodes defined by the specification;

Expand All @@ -38,31 +44,32 @@ For the core OPC UA specifications the following additional files are published:
The files for each companion specification are in a subdirectory with the short name of the specification.
The files for the core specification are in the Schema subdirectory.

### <a name="release">Release Process
**This repository only has the released versions of the normative files.**
## Release Process

**This repository only has the released versions of the normative files.**
Draft and Release Candidate are available in the [member only repository](https://github.com/OPCF-Members/UA-NodeSet).

**The master branch contains draft files so it is only available in the member only repository.**

Instructions on requesting access to the member only repository can be found [here](https://opcf-members.github.io/Help/).

If an error or problem is found in any of the files it should be [reported](https://apps.opcfoundation.org/mantis/main_page.php) as a mantis issue against the appropriate specification.
The files in the 1.04 branch are also public to the OPC Foundation [website](https://opcfoundation.org/UA/schemas/).

The files in the master branch are also public to the OPC Foundation [website](https://opcfoundation.org/UA/schemas/).
**If someone is looking for the officially released version of the UANodeSets they must follow the links in the specification.**

When the files are reviewed and published a tag will be created in this repo with the publication date specified in the UANodeSet.
Note that adding tags is a step that was added late in the process so tags prior to 2019-05-01 do not exist and users must use the dates on the commits.

There are currently 3 branches in the repository:
* master (currently v1.04)
* v1.04

* v1.04 - default
* v1.03
* master (empty) - only available in a private repository

These branches correspond to a release of the OPC UA specification.
When a companion specification is released it will be added to the branch that matches the release of the OPC UA specification used.
If errata are later published for a companion specification the version in the appropriate branch will be updated.
If errata are later published for a companion specification the version in the appropriate branch will be updated.

## Error reporting

If an error or problem is found in any of the files it should be [reported](https://apps.opcfoundation.org/mantis/main_page.php) as a mantis issue against the appropriate specification.

More information on the process can befound [here](https://opcfoundation.org/resources/issue-tracking/).

0 comments on commit 60e66b4

Please sign in to comment.