Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EPUB Media Overlays support and migration from Json.NET to System.Text.Json #78

Merged
merged 14 commits into from
May 7, 2023
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
40 changes: 20 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

## Description
<!-- A clear and concise description of what the bug is. If this bug is related to an unexpected exception thrown by the library, please provide the call stack of the exception here. -->

## Sample EPUB file
<!-- Please provide a link to a sample EPUB file reproducing the bug (unless this EPUB file is under copyright restrictions). -->

## EPUB specification link
<!-- If you believe that the library violates some parts of the EPUB standard, provide a link to a relevant EPUB specification section. EPUB 2 specification can be found here: http://idpf.org/epub/201 and the latest version of EPUB 3 specification is located here: https://www.w3.org/publishing/epub/ -->

## Additional context
<!-- Add any other context about the problem here. -->
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
## Description
<!-- A clear and concise description of what the bug is. If this bug is related to an unexpected exception thrown by the library, please provide the call stack of the exception here. -->
## Sample EPUB file
<!-- Please provide a link to a sample EPUB file reproducing the bug (unless this EPUB file is under copyright restrictions). -->
## EPUB specification link
<!-- If you believe that the library violates some parts of the EPUB standard, provide a link to a relevant EPUB specification section. EPUB 2 specification can be found here: http://idpf.org/epub/201 and the latest version of EPUB 3 specification is located here: https://www.w3.org/publishing/epub/ -->
## Additional context
<!-- Add any other context about the problem here. -->
34 changes: 17 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
name: Feature request
about: Suggest an enhancement for this library
title: ''
labels: enhancement
assignees: ''

---

## Description
<!-- A clear and concise description of what the feature request is. If this request related to a problem, please describe the problem. -->

## Proposed solution
<!-- A clear and concise description of what you want to happen. Provide a code sample if applicable. -->

## Additional context
<!-- Add any other context about the feature request here. -->
---
name: Feature request
about: Suggest an enhancement for this library
title: ''
labels: enhancement
assignees: ''
---
## Description
<!-- A clear and concise description of what the feature request is. If this request related to a problem, please describe the problem. -->
## Proposed solution
<!-- A clear and concise description of what you want to happen. Provide a code sample if applicable. -->
## Additional context
<!-- Add any other context about the feature request here. -->
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: Question
about: Ask a question about the library
title: ''
labels: question
assignees: ''

---

<!-- Write your question here. Provide a code sample if applicable. If your question is related to a specific EPUB file, please add a link to that file. -->
---
name: Question
about: Ask a question about the library
title: ''
labels: question
assignees: ''
---
<!-- Write your question here. Provide a code sample if applicable. If your question is related to a specific EPUB file, please add a link to that file. -->
38 changes: 19 additions & 19 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# {Pull request title}

<!-- Thank you for submitting a pull request! -->

This is:
- [ ] a bug fix
- [ ] an enhancement

<!-- If you'd like to propose a new feature or implement a bug fix, please open an issue to discuss the change or find an existing issue. -->

Related issue: #{issue number}

## Description

<!-- Describe the implementation details. -->

## Testing steps

<!-- Describe how a reviewer can check if the bug is fixed or the feature is working properly. Provide the expected result at the end. -->
# {Pull request title}
<!-- Thank you for submitting a pull request! -->
This is:
- [ ] a bug fix
- [ ] an enhancement
<!-- If you'd like to propose a new feature or implement a bug fix, please open an issue to discuss the change or find an existing issue. -->
Related issue: #{issue number}
## Description
<!-- Describe the implementation details. -->
## Testing steps
<!-- Describe how a reviewer can check if the bug is fixed or the feature is working properly. Provide the expected result at the end. -->
74 changes: 37 additions & 37 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
name: Build

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:

build:

runs-on: windows-2022

env:
Configuration: Debug
Solution_Name: Source\EpubReader.sln

steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Install .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7

- name: Setup MSBuild
uses: microsoft/[email protected]

- name: Restore dependencies
run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true

- name: Build solution
run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration
name: Build
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
runs-on: windows-2022
env:
Configuration: Debug
Solution_Name: Source\EpubReader.sln
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Install .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7
- name: Setup MSBuild
uses: microsoft/[email protected]
- name: Restore dependencies
run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true
- name: Build solution
run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration
104 changes: 52 additions & 52 deletions .github/workflows/generate-docs.yml
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
name: Generate documentation

on: workflow_dispatch

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
generate-documentation:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: windows-2022

steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Install .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7

- name: Restore dependencies
run: dotnet restore .\Source\VersOne.Epub\VersOne.Epub.csproj

- name: Install DocFX
run: nuget install docfx.console -x

- name: Run DocFX
run: docfx.console\tools\docfx.exe Documentation\docfx.json

- name: Setup Pages
uses: actions/configure-pages@v1

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './Documentation/docfx_output'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@main
name: Generate documentation
on: workflow_dispatch
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
generate-documentation:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: windows-2022
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Install .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7
- name: Restore dependencies
run: dotnet restore .\Source\VersOne.Epub\VersOne.Epub.csproj
- name: Install DocFX
run: nuget install docfx.console -x
- name: Run DocFX
run: docfx.console\tools\docfx.exe Documentation\docfx.json
- name: Setup Pages
uses: actions/configure-pages@v1
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './Documentation/docfx_output'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@main
74 changes: 37 additions & 37 deletions .github/workflows/publish-to-nuget.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
name: Publish to Nuget

on: workflow_dispatch

jobs:
create-release:
runs-on: windows-2022

env:
Configuration: Release
Solution_Name: Source\EpubReader.sln

steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Install .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7

- name: Setup MSBuild
uses: microsoft/[email protected]

- name: Restore dependencies
run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true

- name: Build solution
run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration

- name: Make Nuget package
run: nuget.exe pack Source\VersOne.Epub\VersOne.Epub.nuspec

- name: Publish Nuget package
run: nuget.exe push *.nupkg -Source https://api.nuget.org/v3/index.json -ApiKey ${{ secrets.NUGET_API_KEY }} -SkipDuplicate
name: Publish to Nuget
on: workflow_dispatch
jobs:
create-release:
runs-on: windows-2022
env:
Configuration: Release
Solution_Name: Source\EpubReader.sln
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Install .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7
- name: Setup MSBuild
uses: microsoft/[email protected]
- name: Restore dependencies
run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration /p:RestorePackagesConfig=true
- name: Build solution
run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration
- name: Make Nuget package
run: nuget.exe pack Source\VersOne.Epub\VersOne.Epub.nuspec
- name: Publish Nuget package
run: nuget.exe push *.nupkg -Source https://api.nuget.org/v3/index.json -ApiKey ${{ secrets.NUGET_API_KEY }} -SkipDuplicate
Loading