Skip to content

Complete rewrite and v1.0 release preparation#146

Merged
petesramek merged 2094 commits intopreview/1.0from
develop/1.0
Apr 3, 2026
Merged

Complete rewrite and v1.0 release preparation#146
petesramek merged 2094 commits intopreview/1.0from
develop/1.0

Conversation

@petesramek
Copy link
Copy Markdown
Owner

@petesramek petesramek commented Mar 16, 2026 •
edited by Copilot AI
Loading

Complete rewrite and v1.0 release preparation

This PR represents a full rewrite of the PolylineAlgorithm library, modernizing the API surface, improving extensibility, and preparing for a stable v1.0 release targeting .NET Standard 2.1+.

Breaking Changes / New Public API

  • New generic interfaces IPolylineEncoder<TCoordinate, TPolyline> and IPolylineDecoder<TPolyline, TCoordinate> replace the old encoding abstraction, allowing callers to use any coordinate and polyline representation.
  • Abstract base classes AbstractPolylineEncoder<TCoordinate, TPolyline> and AbstractPolylineDecoder<TPolyline, TCoordinate> provide the shared encoding/decoding algorithm; consumers override only GetLatitude, GetLongitude, CreatePolyline (encoder) or CreateCoordinate, GetReadOnlyMemory (decoder).
  • Extension methods PolylineEncoderExtensions and PolylineDecoderExtensions add convenience overloads for List<T> and arrays.
  • PolylineEncoding static utility class exposes low-level normalization, validation, encoding and decoding primitives.
  • PolylineEncodingOptions and PolylineEncodingOptionsBuilder expose configurable precision, stack-alloc buffer limit and ILoggerFactory integration.
  • InvalidPolylineException added for descriptive error reporting on malformed input.
  • All Encode/Decode methods accept an optional CancellationToken.

Other Changes

  • Integrated Microsoft.Extensions.Logging support for diagnostics / CI audit trails.
  • Added PolylineAlgorithm.NetTopologySuite.Sample demonstrating integration with NetTopologySuite.
  • Comprehensive XML doc comments on all public APIs.
  • Updated README, CONTRIBUTING, AGENTS and all guide docs under api-reference/guide/ (getting-started, advanced-scenarios, configuration, FAQ).
  • DocFX API reference updated for v1.0 under api-reference/1.0/.
  • Updated unit tests and benchmarks.

petesramek and others added 30 commits August 23, 2025 14:14
@petesramek
updated diagnostic severity for public api analyzer
990ace6
@petesramek
updated PublicAPi.*.txt
fd3f184
@petesramek
Merge branch 'develop/1.0' of https://github.com/sramekpete/polyline-…
22f6bef 
…algorithm-csharp into develop/1.0
@petesramek
refactored actions and workflows
0c01716
@petesramek
fixed publish package action name
78caf25
@petesramek
fixed name
b737bfa
@petesramek
removed format cs files workflow
3b14694
@petesramek
fixeesss
7b3c4ac
@petesramek
added format dependency
641c8ad
@petesramek
remoived format cs files
b6e32ab
@petesramek
merged
a62a388
@petesramek
renamed pull request wf
87f534a
Merge branch 'preview/1.0' into develop/1.0
b0c1bcd
@petesramek
xacascdqa
9677732
@petesramek
Merge branch 'develop/1.0' of https://github.com/sramekpete/polyline-…
839be1e 
…algorithm-csharp into develop/1.0
@petesramek
zxcas
5d7a363
@petesramek
zxcac
0ab7c43
@github-actions @petesramek
Promote develop/1.0 to preview/1.0 (#62)
3843e8f 
Promote develop/1.0 to preview/1.0

---------

Co-authored-by: Pete Sramek <me@petesramek.com>
Co-authored-by: Pete Sramek <petr.sramek@dropoutcoder.com>
@petesramek
Updated docs for version 1.0
81edbc9
@petesramek
updated publish package job name with development to clarify the publ…
7895ba9 
…ishing package type
@dependabot
Bump actions/upload-pages-artifact from 3 to 4 (#63)
880ea60 
Bumps
[actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact)
from 3 to 4.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/actions/upload-pages-artifact/releases">actions/upload-pages-artifact's
releases</a>.</em></p>
<blockquote>
<h2>v4.0.0</h2>
<h2>What's Changed</h2>
<ul>
<li>Potentially breaking change: hidden files (specifically dotfiles)
will not be included in the artifact by <a
href="https://github.com/tsusdere"><code>@​tsusdere</code></a> in <a
href="https://redirect.github.com/actions/upload-pages-artifact/pull/102">actions/upload-pages-artifact#102</a>
If you need to include dotfiles in your artifact: instead of using this
action, create your own artifact according to these requirements <a
href="https://github.com/actions/upload-pages-artifact?tab=readme-ov-file#artifact-validation">https://github.com/actions/upload-pages-artifact?tab=readme-ov-file#artifact-validation</a></li>
<li>Pin <code>actions/upload-artifact</code> to SHA by <a
href="https://github.com/heavymachinery"><code>@​heavymachinery</code></a>
in <a
href="https://redirect.github.com/actions/upload-pages-artifact/pull/127">actions/upload-pages-artifact#127</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/upload-pages-artifact/compare/v3.0.1...v4.0.0">https://github.com/actions/upload-pages-artifact/compare/v3.0.1...v4.0.0</a></p>
<h2>v3.0.1</h2>
<h1>Changelog</h1>
<ul>
<li>Group tar's output to prevent it from messing up action logs <a
href="https://github.com/SilverRainZ"><code>@​SilverRainZ</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/94">#94</a>)</li>
<li>Update README.md <a
href="https://github.com/uiolee"><code>@​uiolee</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/88">#88</a>)</li>
<li>Bump the non-breaking-changes group with 1 update <a
href="https://github.com/dependabot"><code>@​dependabot</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/92">#92</a>)</li>
<li>Update Dependabot config to group non-breaking changes <a
href="https://github.com/JamesMGreene"><code>@​JamesMGreene</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/91">#91</a>)</li>
<li>Bump actions/checkout from 3 to 4 <a
href="https://github.com/dependabot"><code>@​dependabot</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/76">#76</a>)</li>
</ul>
<p>See details of <a
href="https://github.com/actions/upload-pages-artifact/compare/v3.0.0...v3.0.1">all
code changes</a> since previous release.</p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/7b1f4a764d45c48632c6b24a0339c27f5614fb0b"><code>7b1f4a7</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/127">#127</a>
from heavymachinery/pin-sha</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/4cc19c7d3f3e6c87c68366501382a03c8b1ba6db"><code>4cc19c7</code></a>
Pin <code>actions/upload-artifact</code> to SHA</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/2d163be3ddce01512f3eea7ac5b7023b5d643ce1"><code>2d163be</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/107">#107</a>
from KittyChiu/main</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/c70484322b1c476728dcd37fac23c4dea2a0c51a"><code>c704843</code></a>
fix: linted README</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/9605915f1d2fc79418cdce4d5fbe80511c457655"><code>9605915</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/106">#106</a>
from KittyChiu/kittychiu/update-readme-1</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/e59cdfe6d6b061aab8f0619e759cded914f3ab03"><code>e59cdfe</code></a>
Update README.md</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/a2d67043267d885050434d297d3dd3a3a14fd899"><code>a2d6704</code></a>
doc: updated usage section in readme</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/984864e7b70fb5cb764344dc9c4b5c087662ef50"><code>984864e</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/105">#105</a>
from actions/Jcambass-patch-1</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/45dc78884ca148c05eddcd8ac0a804d3365e9014"><code>45dc788</code></a>
Add workflow file for publishing releases to immutable action
package</li>
<li><a
href="https://github.com/actions/upload-pages-artifact/commit/efaad07812d4b9ad2e8667cd46426fdfb7c22e22"><code>efaad07</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/102">#102</a>
from actions/hidden-files</li>
<li>Additional commits viewable in <a
href="https://github.com/actions/upload-pages-artifact/compare/v3...v4">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/upload-pages-artifact&package-manager=github_actions&previous-version=3&new-version=4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@petesramek
added github release action
188c0ec
@petesramek
updated realse action
7457f07
@petesramek
updated
5178da1
@petesramek
Merge branch 'ci-cd-development' into develop/1.0
1b49059
@petesramek
Merge branch 'develop/1.0' of https://github.com/sramekpete/polyline-…
e833e4a 
…algorithm-csharp into develop/1.0
Merge branch 'preview/1.0' into develop/1.0
3b3e24e
@petesramek
updated
c574b43
@petesramek
Merge branch 'develop/1.0' of https://github.com/sramekpete/polyline-…
88ed30f 
…algorithm-csharp into develop/1.0
@petesramek
fix
8b81bb3
@petesramek
Add URL-aware version switcher to API docs via docs-versioning templa…
89021ee 
…te (#157)

- [x] Add docs-versioning template (layout/_master.tmpl +
version-switcher.js)
- [x] Add versions.json manifest (latest: null, versions: [])
- [x] Add `api-reference/_docs/` to `.gitignore` and untrack it from git
- [x] `api-reference.json` — version content sections removed from repo
(populated dynamically by CI)
- [x] `toc.yml` — Reference dropdown removed from repo (populated
dynamically by CI)
- [x] Fix versioning job output name bug (`friendly-version` →
`version`)
- [x] Add `dotnet-sdk-version: '10.x'` env to
`publish-documentation.yml`
- [x] Rewrite `generate-docs` job: regenerate metadata, patch
api-reference.json/versions.json/toc.yml, inline docfx build
- [x] Fix `docfx-build` action: remove internal checkout, fix
dotnet-version input reference

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: petesramek <2333452+petesramek@users.noreply.github.com>
@petesramek
Copy link
Copy Markdown
Owner Author

petesramek commented Apr 3, 2026

@copilot update description and make a code review.

Copy link
Copy Markdown

Copilot AI commented Apr 3, 2026

@copilot update description and make a code review.

PR description has been updated to accurately reflect the full scope of the v1.0 rewrite (commit d3d234b).

While doing so, I also addressed several outstanding review issues from the automated review:

  • Fixed grammar: "cannot be shorten" → "cannot be shorter" in ExceptionMessageResource.resx
  • Fixed TOC broken link typo: advanced-scenarions.md → advanced-scenarios.md
  • Updated outdated SetMaxBufferSize(...) → WithStackAllocLimit(...) in configuration.md and advanced-scenarios.md

Code review (via parallel_validation) completed with 0 comments and the CodeQL security scan found 0 alerts.

@petesramek
Potential fix for pull request finding
e96677c 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@petesramek petesramek changed the title Develop/1.0 Complete rewrite and v1.0 release preparation Apr 3, 2026
Copilot stopped work on behalf of petesramek due to an error April 3, 2026 22:58
The session was cancelled by the user.
@petesramek petesramek merged commit 75f423e into preview/1.0 Apr 3, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@petesramek