Repository navigation
Release Doc2FAQ v0.5.0 — Source & Review (Java 21–26) #17
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
31a8984
Prepare Doc2FAQ v0.5.0 release candidate and Java 21-27 CI checks
OKAN-SOFTWARE 5983c06
ci: upgrade Node 24 actions and pin Ubuntu runner
OKAN-SOFTWARE 113a8af
ci: avoid duplicate PR runs and limit JDK download concurrency
OKAN-SOFTWARE 1309475
ui: prioritize PDF and Word in export dropdown
OKAN-SOFTWARE 32efcf3
feat: complete Doc2FAQ v0.5.0 browser design and Unicode PDF support
OKAN-SOFTWARE e94f25f
build: package and publish verified Doc2FAQ v0.5.0 downloads
OKAN-SOFTWARE 7b11140
ci: restore protected build-and-test check after full Java matrix
OKAN-SOFTWARE 3049f44
docs: refine Doc2FAQ maintainer voice and release guidance
OKAN-SOFTWARE d13f66a
ci: require Java 21–26 release verification before publishing
OKAN-SOFTWARE File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| name: Publish Doc2FAQ v0.5.0 | ||
|
|
||
| # First run automatically when this workflow lands on main. Manual reruns | ||
| # remain available, but the existing-release check prevents duplicate tags. | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - .github/workflows/publish-v0.5.0.yml | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: doc2faq-v0.5.0-release | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| compatibility: | ||
| name: Release Java ${{ matrix.java }} compatibility | ||
| runs-on: ubuntu-24.04 | ||
| timeout-minutes: 20 | ||
| strategy: | ||
| fail-fast: false | ||
| max-parallel: 2 | ||
| matrix: | ||
| java: ['21', '22', '23', '24', '25', '26'] | ||
| steps: | ||
| - uses: actions/checkout@v7 | ||
| - uses: actions/setup-java@v6 | ||
| with: | ||
| distribution: temurin | ||
| java-version: ${{ matrix.java }} | ||
| cache: maven | ||
| - name: Build, test, and smoke-test the packaged application | ||
| run: | | ||
| mvn -B -ntp clean verify | ||
| bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar | ||
|
|
||
| publish: | ||
| if: github.repository == 'OKAN-SOFTWARE/Doc2FAQ' && github.ref == 'refs/heads/main' | ||
| # GitHub waits for every Java matrix entry; any failure skips publication. | ||
| needs: [compatibility] | ||
| runs-on: ubuntu-24.04 | ||
| timeout-minutes: 25 | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - uses: actions/checkout@v7 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - uses: actions/setup-java@v6 | ||
| with: | ||
| distribution: temurin | ||
| java-version: '21' | ||
| cache: maven | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '22' | ||
|
|
||
| - name: Refuse to replace an existing v0.5.0 release or tag | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| run: | | ||
| if gh release view v0.5.0 >/dev/null 2>&1; then | ||
| echo "v0.5.0 is already published. Refusing to overwrite it." | ||
| exit 1 | ||
| fi | ||
| if [ -n "$(git tag -l v0.5.0)" ]; then | ||
| echo "The v0.5.0 tag already exists. Review it before publishing." | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Build and verify the release JAR | ||
| run: | | ||
| mvn -B -ntp clean verify | ||
| bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar | ||
|
|
||
| - name: Verify browser demo and Doc2FAQ homepage | ||
| run: | | ||
| node --test src/test/js/*.test.cjs | ||
| node scripts/build-website.mjs | ||
| node scripts/verify-website-build.mjs | ||
|
|
||
| - name: Package the Windows and standalone downloads | ||
| shell: bash | ||
| run: | | ||
| set -euo pipefail | ||
| mkdir -p release/staging/Doc2FAQ-0.5.0 | ||
| cp target/doc2faq-0.5.0.jar release/doc2faq-0.5.0.jar | ||
| cp release/doc2faq-0.5.0.jar release/staging/Doc2FAQ-0.5.0/ | ||
| cp packaging/Start-Doc2FAQ.cmd packaging/WINDOWS-QUICK-START.md release/staging/Doc2FAQ-0.5.0/ | ||
| # Windows cmd.exe expects CRLF-terminated batch files. | ||
| sed -i 's/$/\r/' release/staging/Doc2FAQ-0.5.0/Start-Doc2FAQ.cmd | ||
| ( | ||
| cd release/staging | ||
| zip -q -r ../Doc2FAQ-0.5.0-Windows.zip Doc2FAQ-0.5.0 | ||
| ) | ||
| unzip -t release/Doc2FAQ-0.5.0-Windows.zip | ||
| unzip -p release/Doc2FAQ-0.5.0-Windows.zip Doc2FAQ-0.5.0/doc2faq-0.5.0.jar | cmp - release/doc2faq-0.5.0.jar | ||
| ( | ||
| cd release | ||
| sha256sum doc2faq-0.5.0.jar Doc2FAQ-0.5.0-Windows.zip > SHA256SUMS.txt | ||
| sha256sum -c SHA256SUMS.txt | ||
| ) | ||
|
|
||
| - name: Publish exactly the tested commit | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| run: | | ||
| gh release create v0.5.0 \ | ||
| --target "$GITHUB_SHA" \ | ||
| --title "Doc2FAQ v0.5.0 — Source & Review" \ | ||
| --notes-file docs/RELEASE-NOTES-0.5.0.md \ | ||
| --latest \ | ||
| release/doc2faq-0.5.0.jar \ | ||
| release/Doc2FAQ-0.5.0-Windows.zip \ | ||
| release/SHA256SUMS.txt | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,3 +17,4 @@ Thumbs.db | |
|
|
||
| # Generated browser demo (built from tracked sources) | ||
| /demo-dist/ | ||
| /website-dist/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.