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
8 changes: 5 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ jobs:
run:
shell: bash
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
# actions/checkout v6 (v6.0.2), pinned to full commit SHA for supply-chain security.
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
# actions/setup-node v6 (v6.4.0), pinned to full commit SHA for supply-chain security.
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e
with:
node-version: 20
node-version: 24

- name: Install dependencies
run: npm ci
Expand Down
11 changes: 7 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ jobs:
run:
shell: bash
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
# actions/checkout v6 (v6.0.2), pinned to full commit SHA for supply-chain security.
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
# actions/setup-node v6 (v6.4.0), pinned to full commit SHA for supply-chain security.
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e
with:
node-version: 20
node-version: 24

- name: Install dependencies
run: npm ci
Expand All @@ -30,7 +32,8 @@ jobs:
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
# peaceiris/actions-gh-pages v4 (v4.1.0), pinned to full commit SHA for supply-chain security.
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
70 changes: 13 additions & 57 deletions docs/dotnet/changelog/README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,27 @@
---
title: AvatarScriptLink.NET Changelog
title: AvatarScriptLink.NET Release Notes
slug: dotnet/release-notes
image: ./Changelog.png
Comment thread
scottolsonjr marked this conversation as resolved.
---

# Changelog
# Release Notes

[![NuGet Latest](https://img.shields.io/nuget/v/RarelySimple.AvatarScriptLink)](https://www.nuget.org/packages/RarelySimple.AvatarScriptLink/)

## 2.0.0 (Future)
The canonical release history for AvatarScriptLink.NET is published on GitHub:

:::info Subject to Change
The items listed below are under consideration for AvatarScriptLink.NET v.2.
This list is subject to change with some items being descoped or deferred to a later release.
:::
- [GitHub Releases](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/releases)

* Enable cross-platform development (i.e., Linux, MacOS, and Windows) and build of AvatarScriptLink.NET.
* Split library into multiple NuGet packages
* `RarelySimple.AvatarScriptLink.Objects`: Simple package that provides just the ScriptLink objects without all of the helpers and other utilities. Work with ScriptLink your way.
* `RarelySimple.AvatarScriptLink.Net`: Fully featured library with helpers and utilities to help accelerate ScriptLink API development in .NET and .NET Framework. Depends on `RarelySimple.AvatarScriptLink.Objects`.
* `RarelySimple.AvatarScriptLink.Services`: SOAP Service definitions for .NET 8 and later. Depends on `RarelySimple.AvatarScriptLink.Objects`.
* Add support for Native AOT.
* Drop support for .NET Framework 4.6.1
* Remove dependency on `Newtonsoft.Json`.
* Include added Field and Row objects by default in returned OptionObjects.
* Correct an issue in which attributes in a newer version of the OptionObject are accessible in older versions.
For the most accurate per-version details, start with GitHub Releases.

## 1.2.0 (2023-06-25)
## What you will find here

* Introduce Builder methods for each object to assist with object creation.
* OptionObject2015 (incl. OptionObject2, OptionObject). Issue [#40](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/40)
* FormObject. Issue [#39](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/39)
* RowObject. Issue [#38](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/38)
* FieldObject. Issue [#37](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/37)
* Allow for error code and message to be set prior to creation of return OptionObject. Issue [#52](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/52)
This docs page may include:

## 1.1.10 (2022-10-15)
- breaking changes that require action,
- migration guidance,
- links to deeper documentation.

* Corrects an issue preventing some forms from opening. Issue [#22](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/22)
## Looking for package downloads?

## 1.1.6 (2022-09-04)

* Setting a field as required or disabled will no longer change other FieldObject attributes. Issue [#20](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/20)

## 1.0.28 (2022-07-25)

* Addresses CVE-2020-11022. Issue [#8](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/8)
* Addressed CVE-2020-11023. Issue [#7](https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/issues/7)

## 1.0.25 (2022-05-20)

* Maintenance release to update dependencies.
* NuGet will now show a README.

## 1.0.22 (2021-08-08)

* Addresses security vulnerabilities from dependencies.
* Converting OptionObject content to HTML has been improved.
* Miscellaneous code quality improvements.

## 1.0.7 (2020-12-12)

* Corrects an issue that occurs when the myAvatar registry setting, "Include FormObject for sections without a current row selected" is set to "Y".

## 1.0.6 (2020-06-09)

* Minor updates to initial release.

## 1.0.3 (2020-02-21)

* Initial release of AvatarScriptLink.NET.
- [NuGet: RarelySimple.AvatarScriptLink](https://www.nuget.org/packages/RarelySimple.AvatarScriptLink/)
16 changes: 12 additions & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ const config = {
url: 'https://scriptlink.rarelysimple.com/',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/asl-logo.svg',

organizationName: 'rarelysimple',
Expand All @@ -25,6 +24,9 @@ const config = {

markdown: {
mermaid: true,
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},
themes: ['@docusaurus/theme-mermaid'],

Expand All @@ -35,9 +37,11 @@ const config = {
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/tree/main/docs/',
editUrl: 'https://github.com/rarelysimple/rs-scriptlink-docs/tree/main/docs/',
includeCurrentVersion: false,
onlyIncludeVersions: [
'1.2.0'
],
},
// blog: false,
blog: {
Expand Down Expand Up @@ -103,6 +107,10 @@ const config = {
label: 'Data Model',
to: '/docs/dotnet/data-model',
},
{
label: 'Release Notes',
href: 'https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/releases',
},
{
label: 'License',
href: 'https://github.com/rarelysimple/RarelySimple.AvatarScriptLink/blob/master/LICENSE',
Expand Down
Loading