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

Removes version and commit from help files, adds new way to update sitemap.xml #190

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
80 changes: 80 additions & 0 deletions .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]
paths:
- docs/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: '0'
- name: Support
uses: actions/checkout@v4
with:
repository: masesgroup/WebSitesSupport
path: WebSitesSupport
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Setup IndexNow # Generate files dynamically to prevent them from being leaked in public repositories.
run: echo ${{ secrets.INDEXNOW_KEY }} > ./docs/${{ secrets.INDEXNOW_KEY }}.txt
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs/
destination: ./_site
- name: Sitemap lastmod replacer
shell: pwsh
run: ./WebSitesSupport/SitemapLastmodReplacer.ps1 -baseUrl https://jcoreflector.masesgroup.com -baseFolder ${{ github.workspace }}/docs/ -inSitemapFile ${{ github.workspace }}/_site/sitemap.xml -outSitemapFile ${{ github.workspace }}/sitemap.xml
- run: sudo cp ${{ github.workspace }}/sitemap.xml ${{ github.workspace }}/_site/sitemap.xml
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
outputs:
page_url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

# commented since the action does not support more than 10000 files
#indexing:
# runs-on: ubuntu-latest
# needs: deploy
# steps:
# - name: IndexNow Action
# uses: bojieyang/indexnow-action@v2
# with:
# sitemap-location: '${{ needs.deploy.outputs.page_url }}sitemap.xml'
# key: ${{ secrets.INDEXNOW_KEY }}
# limit: 10000
# timeout: 600000
2 changes: 1 addition & 1 deletion src/net/CLI/JCOReflectorCLI.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<Copyright>Copyright © MASES s.r.l. 2024</Copyright>
<Authors>MASES s.r.l.</Authors>
<Company>MASES s.r.l.</Company>
<Version>1.14.3.0</Version>
<Version>1.14.4.0</Version>
<Product>MASES.JCOReflectorCLI</Product>
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
<TargetFrameworks>net462;net6.0;net8.0</TargetFrameworks>
Expand Down
2 changes: 1 addition & 1 deletion src/net/CLI/JCOReflectorCLI.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata>
<id>MASES.JCOReflectorCLI</id>
<version>1.14.3</version>
<version>1.14.4</version>
<title>JCOReflector CLI - CLI interface for JCOReflector Engine</title>
<authors>MASES s.r.l.</authors>
<owners>MASES s.r.l.</owners>
Expand Down
2 changes: 1 addition & 1 deletion src/net/GUI/JCOReflectorGUI.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<Copyright>Copyright © MASES s.r.l. 2024</Copyright>
<Authors>MASES s.r.l.</Authors>
<Company>MASES s.r.l.</Company>
<Version>1.14.3.0</Version>
<Version>1.14.4.0</Version>
<Product>JCOReflectorGUI</Product>
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
<TargetFrameworks>net462;net6.0-windows;net8.0-windows</TargetFrameworks>
Expand Down
2 changes: 1 addition & 1 deletion src/net/engine/JCOReflectorEngine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<Copyright>Copyright © MASES s.r.l. 2024</Copyright>
<Authors>MASES s.r.l.</Authors>
<Company>MASES s.r.l.</Company>
<Version>1.14.3.0</Version>
<Version>1.14.4.0</Version>
<Product>MASES.JCOReflectorEngine</Product>
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
<TargetFrameworks>net462;net6.0;net8.0</TargetFrameworks>
Expand Down
2 changes: 1 addition & 1 deletion src/net/engine/JavaBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ static async Task<int> CreateSourceListAndGenerateDocs(string jdkFolder, JDKVers
destinationFolder = Path.Combine(destinationFolder, Const.Framework.RuntimeFolder);
destinationFolder = destinationFolder.Replace('\\', '/');
var extraOptions = string.IsNullOrEmpty(toolExtraOptions) ? string.Empty : string.Format(" {0} ", toolExtraOptions);
var header = Const.Documentation.DOCS_HEADER.Replace(Const.Documentation.DOCS_VERSION_JCOREFLECTOR_PLACEHOLDER, string.Format("v{0}-{1}", Const.ReflectorVersion, commitVersion));
var header = Const.Documentation.DOCS_HEADER.Replace(Const.Documentation.DOCS_VERSION_JCOREFLECTOR_PLACEHOLDER, string.Empty); // removed to produce more stable documentation string.Format("v{0}-{1}", Const.ReflectorVersion, commitVersion));
await LaunchProcess(sourceFolder, Path.Combine(jdkFolder, JavaDoc), "-header \"" + header + "\" -keywords -quiet -author -noindex -nodeprecated -nodeprecatedlist -notimestamp -nohelp -notree -public -cp " + jcoBridgeCp + " -d " + destinationFolder + extraOptions + " -link https://www.jcobridge.com/api-java_" + Const.JCOBridgeVersion + " @" + Const.FileNameAndDirectory.SourceFile, timeout);

return counter;
Expand Down
Loading