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.

Sign up for GitHub

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

feat: deploy to github pages #1

Merged
merged 7 commits into from
Aug 19, 2024
Merged

feat: deploy to github pages #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7e517fc
feat: deploy to github pages
paulovareiro29 Aug 9, 2024
838f67a
fix: relative asset paths
paulovareiro29 Aug 9, 2024
446e05e
chore: add bootstrap from cdn to deployment index file (wip)
paulovareiro29 Aug 9, 2024
0d2d368
feat: implement build preview with latest styles (wip)
paulovareiro29 Aug 9, 2024
9c8f05b
fix: missing css file
paulovareiro29 Aug 9, 2024
d9f1752
fix: missing assets folder
paulovareiro29 Aug 9, 2024
343691f
feat: remove all pages to be build for faster preview page build
paulovareiro29 Aug 9, 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
102 changes: 102 additions & 0 deletions .github/workflows/deploy-to-github-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
name: Deploy to GitHub Pages

on:
push:
branches: ['main']
pull_request:
workflow_dispatch:

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

concurrency:
group: 'pages'
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 18

- uses: pnpm/action-setup@v2
name: Install pnpm
id: pnpm-install
with:
version: 8.6.2
run_install: false

- name: Install dependencies
run: pnpm i

- name: Build
run: pnpm build

- name: Prepare deployment directory
run: |
BRANCH_NAME=$(echo ${GITHUB_HEAD_REF:-${GITHUB_REF_NAME}} | tr '/' '_')
mkdir -p deployment/archives
mkdir -p deployment/${BRANCH_NAME}
cp -r dist/* deployment/${BRANCH_NAME}/

- name: Create archive
run: |
BRANCH_NAME=$(echo ${GITHUB_HEAD_REF:-${GITHUB_REF_NAME}} | tr '/' '_')
mkdir -p deployment/archives
tar -czf deployment/archives/${BRANCH_NAME}.tar -C deployment/${BRANCH_NAME} .

- name: Download and unpack existing archives
run: |
BRANCH_NAME=$(echo ${GITHUB_HEAD_REF:-${GITHUB_REF_NAME}} | tr '/' '_')
mkdir -p deployment/archives
git fetch --all
for branch in $(git branch -r | grep -v '\->' | sed 's/origin\///'); do
safe_branch=$(echo ${branch} | tr '/' '_')
if [ "${safe_branch}" != "${BRANCH_NAME}" ]; then
echo "Checking for existing archive for branch: ${branch}"
if curl --head --fail -s https://virtualidentityag.github.io/stadtKoeln-openData-frontend/archives/${safe_branch}.tar; then
echo "Downloading archive for branch: ${branch}"
curl -L -o deployment/archives/${safe_branch}.tar https://virtualidentityag.github.io/stadtKoeln-openData-frontend/archives/${safe_branch}.tar
mkdir -p deployment/${safe_branch}
tar -xzf deployment/archives/${safe_branch}.tar -C deployment/${safe_branch}
else
echo "Branch ${branch} was not deployed to GitHub Pages"
fi
fi
done

- name: Generate index file
run: |
branches=$(ls deployment/archives/*.tar | xargs -n 1 basename | sed 's/.tar//')
echo "branches=$branches" >> $GITHUB_ENV
node scripts/build-preview.js $branches > deployment/index.html
rm -rf src/pages/*
cp deployment/index.html src/pages/preview.twig
pnpm build
rm deployment/index.html
mkdir -p deployment/assets
mv dist/preview.html deployment/index.html
mv dist/assets/styles*.css deployment/assets/

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the deployment directory
path: 'deployment'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
26 changes: 26 additions & 0 deletions scripts/build-preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
const processBranches = (branches) =>
branches
.map((branch) => `<li><a href='./${branch}/'>${branch}</a></li>`)
.join('')

const main = () => {
const branches = process.argv.slice(2)
console.log(
`
<html>
<head>
<title>Stadt Koeln - Open Data</title>
<link rel='stylesheet' href='/src/styles/styles.scss'>
</head>
<body>
<h1>Deployed Branches</h1>
<ul>
${processBranches(branches)}
</ul>
</body>
</html>
`.trim()
)
}

main()
5 changes: 5 additions & 0 deletions vite.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,9 @@ export default {
},
}),
],
experimental: {
renderBuiltUrl(filename) {
return `./${filename}`
},
},
}
Loading