From 4832c597c578eacf77f1a61af49e430673070b40 Mon Sep 17 00:00:00 2001 From: Marcel <1721382+pyrocumulus@users.noreply.github.com> Date: Thu, 4 May 2023 20:57:48 +0200 Subject: [PATCH 1/2] Release 0.11.2 Updated documentation Changed `master` to `main` and fixed other trivial things --- .github/workflows/docfx.yml | 2 +- .github/workflows/publish-nuget.yml | 2 +- CHANGELOG.md | 12 +++++- LICENSE | 2 +- README.md | 4 +- codecov.yml | 2 +- docfx/articles/coverage.md | 40 +++++++++---------- docfx/index.md | 2 +- .../Modules/Interfaces/IStatusService.cs | 2 +- src/PVOutput.Net/PVOutput.Net.csproj | 2 +- 10 files changed, 40 insertions(+), 30 deletions(-) diff --git a/.github/workflows/docfx.yml b/.github/workflows/docfx.yml index 47197d0..8a69429 100644 --- a/.github/workflows/docfx.yml +++ b/.github/workflows/docfx.yml @@ -2,7 +2,7 @@ name: Docfx on: push: - branches: [ master ] + branches: [ main ] jobs: build_and_test: diff --git a/.github/workflows/publish-nuget.yml b/.github/workflows/publish-nuget.yml index ce6c62f..577aa57 100644 --- a/.github/workflows/publish-nuget.yml +++ b/.github/workflows/publish-nuget.yml @@ -2,7 +2,7 @@ name: publish to nuget on: push: branches: - - master # Default release branch + - main # Default release branch jobs: publish: name: build, pack & publish diff --git a/CHANGELOG.md b/CHANGELOG.md index 165cb81..f4ec9a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,11 +3,21 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). -## Unreleased +## [0.11.2] - 2023-05-04 ### Fixed - Updated README formatting for NuGet package page [#132](https://github.com/pyrocumulus/pvoutput.net/pull/132) +- Fixed all API links from XML documentation [#133](https://github.com/pyrocumulus/pvoutput.net/pull/133) +- Updated API links from documentation page +- Updated documentation to reflect the rename of primary branch `master` to `main` + +### Updated + +- Updated `Microsoft.Extensions.Logging.Abstractions` from `v6.0.1` to `v7.0.0` [#147](https://github.com/pyrocumulus/pvoutput.net/pull/147) +- Updated `Microsoft.Extensions.DependencyInjection.Abstractions` from `v6.0.0` to `v7.0.0` [#151](https://github.com/pyrocumulus/pvoutput.net/pull/151) +- Updated `Tavis.UriTemplates` from `v1.1.1` to `v2.0.0` [#153](https://github.com/pyrocumulus/pvoutput.net/pull/153) + ## [0.11.1] - 2022-07-24 diff --git a/LICENSE b/LICENSE index 4f29e6a..f927f6f 100644 --- a/LICENSE +++ b/LICENSE @@ -4,7 +4,7 @@ All other copyright for project PVOutput.Net are held by: The MIT License (MIT) -Copyright (c) [2018 - 2020] Marcel Boersma and contributors. +Copyright (c) [2018 - 2023] Marcel Boersma and contributors. Permission is hereby granted, free of charge, to any person obtaining a copy of diff --git a/README.md b/README.md index 5ed0743..1643673 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ > A .NET Core (Standard 2.0 compatible) wrapper library for API of the popular [PVOutput](https://pvoutput.org) service. > PVOutput is a free service for sharing and comparing PV output data. -![GitHub last commit (master)](https://img.shields.io/github/last-commit/pyrocumulus/PVOutput.Net/master?label=last%20commit%20%28master%29) +![GitHub last commit (main)](https://img.shields.io/github/last-commit/pyrocumulus/PVOutput.Net/main?label=last%20commit%20%28main%29) [![NuGet Version](https://img.shields.io/nuget/v/PVOutput.Net.svg?logo=nuget)](https://www.nuget.org/packages/PVOutput.Net/) [![NuGet Downloads](https://img.shields.io/nuget/dt/PVOutput.Net.svg?logo=nuget)](https://www.nuget.org/packages/PVOutput.Net/) [![fuget](https://www.fuget.org/packages/PVOutput.Net/badge.svg)](https://www.fuget.org/packages/PVOutput.Net) @@ -27,7 +27,7 @@ See [Changelog](CHANGELOG.md) for information on changes per version, including This library is targeting .NET Standard 2.0 and above. For full compatibility details, check the [Microsoft Docs](https://docs.microsoft.com/nl-nl/dotnet/standard/net-standard#net-implementation-support). **Please note:** that the default branch of the repository is `develop`. This means that it can contain bugfixes/features that are not yet available in the NuGet package. -See [master](https://github.com/pyrocumulus/pvoutput.net/tree/master) for the source code, that was used for building the NuGet package. +See [main](https://github.com/pyrocumulus/pvoutput.net/tree/main) for the source code, that was used for building the NuGet package. ## Basic usage diff --git a/codecov.yml b/codecov.yml index fca6851..2db5ac9 100644 --- a/codecov.yml +++ b/codecov.yml @@ -4,7 +4,7 @@ codecov: coverage: precision: 2 round: down - range: "70..100 + range: "70..100" threshold: 2% parsers: diff --git a/docfx/articles/coverage.md b/docfx/articles/coverage.md index 38da34e..f5a3a68 100644 --- a/docfx/articles/coverage.md +++ b/docfx/articles/coverage.md @@ -4,23 +4,23 @@ Currently all read operations of the API are implemented as are all of the opera | Operation | Object | Module | Status | Documentation link | |------------|--------------|-------------------|--------------------|-------------------------| -| Add | Output | Output | :heavy_check_mark: | [Add Output](https://pvoutput.org/help.html#api-addoutput) | -| Get | Output | Output | :heavy_check_mark: | [Get Output](https://pvoutput.org/help.html#api-getoutput) | -| Add | Status | Status | :heavy_check_mark: | [Add Status](https://pvoutput.org/help.html#api-addstatus) | -| Add | Batch Status | Status | :heavy_check_mark: | [Add Batch Status](https://pvoutput.org/help.html#api-addbatchstatus) | -| Get | Status | Status | :heavy_check_mark: | [Get Status](https://pvoutput.org/help.html#api-getstatus) | -| Delete | Status | Status | :heavy_check_mark: | [Delete Status](https://pvoutput.org/help.html#api-deletestatus) | -| Get | Statistic | Statistics | :heavy_check_mark: | [Get Statistic](https://pvoutput.org/help.html#api-getstatistic) | -| Get | System | System | :heavy_check_mark: | [Get System](https://pvoutput.org/help.html#api-getsystem) | -| Post | System | System | :heavy_check_mark: | [Post System](https://pvoutput.org/help.html#api-postsystem) | -| Get | Extended | Extended | :heavy_check_mark: | [Get Extended](https://pvoutput.org/help.html#api-getextended) | -| Get | Favourite | Favourite | :heavy_check_mark: | [Get Favourite](https://pvoutput.org/help.html#api-getfavourite) | -| Get | Missing | Missing | :heavy_check_mark: | [Get Missing](https://pvoutput.org/help.html#api-getmissing) | -| Get | Insolation | Insolation | :heavy_check_mark: | [Get Insolation](https://pvoutput.org/help.html#api-getinsolation) | -| Get | Team | Team | :heavy_check_mark: | [Get Team](https://pvoutput.org/help.html#api-getteam) | -| Join | Team | Team | :heavy_check_mark: | [Join Team](https://pvoutput.org/help.html#api-jointeam) | -| Leave | Team | Team | :heavy_check_mark: | [Leave Team](https://pvoutput.org/help.html#api-leaveteam) | -| Get | Supply | Supply | :heavy_check_mark: | [Get Supply](https://pvoutput.org/help.html#api-getsupply) | -| Search | Search | Search | :heavy_check_mark: | [Search](https://pvoutput.org/help.html#api-search) | -| Register | Notification | Notification | :heavy_check_mark: | [Register Notification](https://pvoutput.org/help.html#api-registernotification) | -| Deregister | Notification | Notification | :heavy_check_mark: | [Deregister Notification](https://pvoutput.org/help.html#api-deregisternotification) | +| Add | Output | Output | :heavy_check_mark: | [Add Output](https://pvoutput.org/help/api_specification.html#add-output-service) | +| Get | Output | Output | :heavy_check_mark: | [Get Output](https://pvoutput.org/help/api_specification.html#get-output-service) | +| Add | Status | Status | :heavy_check_mark: | [Add Status](https://pvoutput.org/help/api_specification.html#add-status-service) | +| Add | Batch Status | Status | :heavy_check_mark: | [Add Batch Status](https://pvoutput.org/help/api_specification.html#add-batch-status-service) | +| Get | Status | Status | :heavy_check_mark: | [Get Status](https://pvoutput.org/help/api_specification.html#get-status-service) | +| Delete | Status | Status | :heavy_check_mark: | [Delete Status](https://pvoutput.org/help/api_specification.html#delete-status-service) | +| Get | Statistic | Statistics | :heavy_check_mark: | [Get Statistic](https://pvoutput.org/help/api_specification.html#get-statistic-service) | +| Get | System | System | :heavy_check_mark: | [Get System](https://pvoutput.org/help/api_specification.html#get-system-service) | +| Post | System | System | :heavy_check_mark: | [Post System](https://pvoutput.org/help/api_specification.html#post-system-service) | +| Get | Extended | Extended | :heavy_check_mark: | [Get Extended](https://pvoutput.org/help/api_specification.html#get-extended-service) | +| Get | Favourite | Favourite | :heavy_check_mark: | [Get Favourite](https://pvoutput.org/help/api_specification.html#get-favourite-service) | +| Get | Missing | Missing | :heavy_check_mark: | [Get Missing](https://pvoutput.org/help/api_specification.html#get-missing-service) | +| Get | Insolation | Insolation | :heavy_check_mark: | [Get Insolation](https://pvoutput.org/help/api_specification.html#get-insolation-service) | +| Get | Team | Team | :heavy_check_mark: | [Get Team](https://pvoutput.org/help/api_specification.html#get-team-service) | +| Join | Team | Team | :heavy_check_mark: | [Join Team](https://pvoutput.org/help/api_specification.html#join-team-service) | +| Leave | Team | Team | :heavy_check_mark: | [Leave Team](https://pvoutput.org/help/api_specification.html#leave-team-service) | +| Get | Supply | Supply | :heavy_check_mark: | [Get Supply](https://pvoutput.org/help/api_specification.html#get-supply-service) | +| Search | Search | Search | :heavy_check_mark: | [Search](https://pvoutput.org/help/searching.html#searching) | +| Register | Notification | Notification | :heavy_check_mark: | [Register Notification](https://pvoutput.org/help/api_specification.html#register-notification-service) | +| Deregister | Notification | Notification | :heavy_check_mark: | [Deregister Notification](https://pvoutput.org/help/api_specification.html#deregister-notification-service) | diff --git a/docfx/index.md b/docfx/index.md index 1251b25..e957f84 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -13,7 +13,7 @@ PM> Install-Package PVOutput.Net ## Changelog -See [Changelog](https://github.com/pyrocumulus/pvoutput.net/blob/master/CHANGELOG.md) for information on changes per version.To see coming but unreleased changes, see the `develop` branch. +See [Changelog](https://github.com/pyrocumulus/pvoutput.net/blob/main/CHANGELOG.md) for information on changes per version.To see coming but unreleased changes, see the `develop` branch. ## Support diff --git a/src/PVOutput.Net/Modules/Interfaces/IStatusService.cs b/src/PVOutput.Net/Modules/Interfaces/IStatusService.cs index d41ee3f..e019fd1 100644 --- a/src/PVOutput.Net/Modules/Interfaces/IStatusService.cs +++ b/src/PVOutput.Net/Modules/Interfaces/IStatusService.cs @@ -82,7 +82,7 @@ public interface IStatusService /// /// Adds multiple statuses to the owned system. - /// See the official API information. + /// See the official API information. /// Use the to create objects. /// /// The statuses to add. diff --git a/src/PVOutput.Net/PVOutput.Net.csproj b/src/PVOutput.Net/PVOutput.Net.csproj index 0e69abe..5b8a8c0 100644 --- a/src/PVOutput.Net/PVOutput.Net.csproj +++ b/src/PVOutput.Net/PVOutput.Net.csproj @@ -19,7 +19,7 @@ snupkg true For release notes see: -https://github.com/pyrocumulus/pvoutput.net/blob/master/CHANGELOG.md +https://github.com/pyrocumulus/pvoutput.net/blob/main/CHANGELOG.md PVOutput.Net logo.png README.md From 4e1aa8f48e1d1a2b97f984c4009685ca617b63ef Mon Sep 17 00:00:00 2001 From: Marcel <1721382+pyrocumulus@users.noreply.github.com> Date: Thu, 4 May 2023 21:01:41 +0200 Subject: [PATCH 2/2] Update CHANGELOG.md --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4ec9a4..c4c80cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - Updated `Microsoft.Extensions.DependencyInjection.Abstractions` from `v6.0.0` to `v7.0.0` [#151](https://github.com/pyrocumulus/pvoutput.net/pull/151) - Updated `Tavis.UriTemplates` from `v1.1.1` to `v2.0.0` [#153](https://github.com/pyrocumulus/pvoutput.net/pull/153) - ## [0.11.1] - 2022-07-24 ### Fixed