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

Main #6

Merged
merged 35 commits into from
Sep 29, 2024
Merged
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
9d58740
Revert "fix(docs): fixes pipeline for Writerside"
csantiago132 Sep 29, 2024
4e21979
fix(docs): fixes pipeline for Writerside
csantiago132 Sep 29, 2024
c9535e9
fix(docs): adds GH_TOKEN
csantiago132 Sep 29, 2024
835b201
Merge remote-tracking branch 'origin/main'
csantiago132 Sep 29, 2024
60ae8e7
Update build_docs.yml
csantiago132 Sep 29, 2024
802f062
fix(docs): github actions
csantiago132 Sep 29, 2024
5c62e98
Merge remote-tracking branch 'origin/main'
csantiago132 Sep 29, 2024
f8df176
fix(docs): changes path for location in Writerside config
csantiago132 Sep 29, 2024
7ddff08
fix(docs): changes docker version
csantiago132 Sep 29, 2024
788b9f6
fix(docs): changes docker version
csantiago132 Sep 29, 2024
c5564f7
Merge remote-tracking branch 'origin/main'
csantiago132 Sep 29, 2024
db3629c
fix(docs): changes docker version
csantiago132 Sep 29, 2024
4960c72
fix(docs): docker pull registry.jetbrains.team/p/writerside & changes…
csantiago132 Sep 29, 2024
b37dc6b
fix(docs): webHelpKSS2-all.zip
csantiago132 Sep 29, 2024
638059a
fix(docs): changes DOCKER_VERSION to latest
csantiago132 Sep 29, 2024
68a0f04
fix(docs): changes DOCKER_VERSION to latest again
csantiago132 Sep 29, 2024
facde29
fix(docs): adds writerside-config.xml
csantiago132 Sep 29, 2024
26cbc92
fix(docs): renames path to Writerside/kurocado-studio-styleguide
csantiago132 Sep 29, 2024
5dd504f
fix(docs): renames path to Writerside/kurocado-studio-styleguide
csantiago132 Sep 29, 2024
a81306f
fix(docs): renames path to Writerside/kurocado-studio-styleguide /kss…
csantiago132 Sep 29, 2024
9f3c01c
fix(docs): restructures Writerside/docs
csantiago132 Sep 29, 2024
d84cc9d
fix(docs): adds secrets.GITHUB_TOKEN
csantiago132 Sep 29, 2024
d55b649
fix(docs): adds secrets.GITHUB_TOKEN
csantiago132 Sep 29, 2024
3a05528
Merge remote-tracking branch 'origin/main'
csantiago132 Sep 29, 2024
d97901f
fix(docs): updates file
csantiago132 Sep 29, 2024
97abdca
fix(docs): adds back GH_TOKEN
csantiago132 Sep 29, 2024
ac2692f
fix(docs): build Writerside Documentation
csantiago132 Sep 29, 2024
8aa13fe
fix(docs): build Writerside Documentation
csantiago132 Sep 29, 2024
59aae3f
fix(docs): webHelpDocs2-all.zip
csantiago132 Sep 29, 2024
4d490d9
fix(docs): webHelpDocs2-all.zip
csantiago132 Sep 29, 2024
f504b27
fix(docs): adds back secrets.GH_TOKEN
csantiago132 Sep 29, 2024
a3797b8
fix(docs): adds back secrets.GITHUB_TOKEN
csantiago132 Sep 29, 2024
4acde69
fix(docs): adds back secrets.GH_TOKEN
csantiago132 Sep 29, 2024
2e2daba
fix(docs): writerside/docs
csantiago132 Sep 29, 2024
d74f451
fix(docs): writerside/dcs
csantiago132 Sep 29, 2024
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
Prev Previous commit
Next Next commit
fix(docs): webHelpDocs2-all.zip
csantiago132 committed Sep 29, 2024
commit 4d490d92d493c9bb4e6da06e7cc8cd1abcd2e4a6
44 changes: 22 additions & 22 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -2,17 +2,17 @@ name: Build and Deploy Writerside Documentation

on:
push:
branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch
branches: ['main'] # Trigger the workflow on push to the main branch
workflow_dispatch: # Allow manual triggering of the workflow

permissions:
id-token: write
pages: write

env:
INSTANCE: Writerside/docs # This references the module name
ARTIFACT: webHelpDocs2-all.zip # Adjust artifact name if necessary
DOCKER_VERSION: 242.21870
INSTANCE: Writerside/docs # Adjust instance to reflect Writerside module and product
ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if needed
DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup

jobs:
build:
@@ -22,17 +22,19 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT) or GITHUB_TOKEN for authentication
fetch-depth: 0

- name: Pull Writerside Docker image
run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}

- name: Build Writerside docs using Docker
run: |
/opt/builder/bin/idea.sh helpbuilderinspect -source-dir /github/workspace/Writerside -product docs
- name: Build Writerside Documentation
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}

- name: Upload artifact
- name: Upload artifact for deployment
uses: actions/upload-artifact@v4
with:
name: docs
@@ -41,31 +43,29 @@ jobs:
retention-days: 7

deploy:
environment:
name: github-pages
needs: build
runs-on: ubuntu-latest
needs: build

permissions:
pages: write # Permissions to publish to GitHub Pages
id-token: write

steps:
- name: Download artifact
- name: Download artifact for deployment
uses: actions/download-artifact@v4
with:
name: docs

- name: Unzip artifact
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir

- name: Setup Pages
uses: actions/configure-pages@v4.0.0
- name: Configure GitHub Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3.0.1
- name: Upload artifact to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: dir

- name: Deploy to GitHub Pages
id: deployment
uses: actions/[email protected]

- name: Print GitHub Pages URL
run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}"
uses: actions/deploy-pages@v4