Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@

All notable changes are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
and the project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) with one rule for versions before
1.0: a patch release is additive, and a minor release may break the API and the file format.
1.0: a patch release adds or fixes, and a minor release may break the API and the file format.

## [Unreleased]

### Fixed
- README and `docs/contract.md`: a package that depends on IOScene references `[0.N.0, 0.N+1.0-0.0)` instead of
`[0.N.0, 0.N+1.0-0)`. nuget.org refuses a package whose dependency bound is `0.2.0-0`, because a prerelease label of
one part must start with a letter there; `0.2.0-0.0` has two parts and keeps out every preview of 0.2.0 except
`0.2.0-0`, which IOScene does not publish.
- `docs/keys.md`: the `ifc:` formats are fixed from `IfcIO.Scene` 0.11.1, its first release; nuget.org refused 0.11.0.

## [0.1.0] - 2026-11-13

First stable release. The API, the file format (kind `ioscene`, format 1) and the validation codes are those of
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,16 @@ dotnet add package IOScene
```

A package that depends on IOScene references one 0.x line, because a 0.x minor release may break the API and a patch
release never does. For the line 0.N the range is `[0.N.0, 0.N+1.0-0)`; the `-0` keeps out the previews of the next
line:
release never does. For the line 0.N the range is `[0.N.0, 0.N+1.0-0.0)`; the `-0.0` keeps out the previews of the
next line:

```xml
<PackageReference Include="IOScene" Version="[0.1.0, 0.2.0-0)" />
<PackageReference Include="IOScene" Version="[0.1.0, 0.2.0-0.0)" />
```

`dotnet pack` of a stable package reports NU5104 for this range, because its upper bound `0.2.0-0` is a prerelease
version; add `<NoWarn>$(NoWarn);NU5104</NoWarn>` to the referencing project.
`dotnet pack` of a stable package reports NU5104 for this range, because its upper bound `0.2.0-0.0` is a prerelease
version; add `<NoWarn>$(NoWarn);NU5104</NoWarn>` to the referencing project. The bound has two labels because
nuget.org refuses a dependency bound such as `0.2.0-0`, whose one prerelease label does not start with a letter.

## Quick start

Expand Down
4 changes: 2 additions & 2 deletions docs/contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ The reader keeps enum numbers it does not know, and writes them back.
### Versions

In 0.x a patch release is additive or fixes a defect, and a minor release is breaking. A package that depends on
`IOScene` 0.N references the range `[0.N.0, 0.N+1.0-0)`; the `-0` keeps out the previews of the next breaking line.
From 1.0 the range is `[1.M.0, 2.0.0-0)`.
`IOScene` 0.N references the range `[0.N.0, 0.N+1.0-0.0)`; the `-0.0` keeps out the previews of the next breaking
line (nuget.org refuses the shorter bound `-0` in a dependency). From 1.0 the range is `[1.M.0, 2.0.0-0.0)`.

## 6. Names

Expand Down
2 changes: 1 addition & 1 deletion docs/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This file is the registry of the namespaces, of their key formats and of the `Sc
| Namespace | Owner package | Status |
|---|---|---|
| `revit:` | `RvtIO.Scene` | registered; the formats below are fixed from the first release of the package, 0.4.0 |
| `ifc:` | `IfcIO.Scene` | registered; the formats below are fixed from the first release of the package, 0.11.0 |
| `ifc:` | `IfcIO.Scene` | registered; the formats below are fixed from the first release of the package, 0.11.1 |

No other namespace is registered. Producers for NWC, DWG and other formats register theirs when they are written.

Expand Down
Loading