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

ci: Add GH workflow to build app & deploy to GH Pages; Update demo link to point at GH Pages deployment. #114

Merged
merged 22 commits into from
Nov 10, 2024
Merged

ci: Add GH workflow to build app & deploy to GH Pages; Update demo link to point at GH Pages deployment. #114

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
718bc34
Add workflow "Deploy to GitHub Pages".
junhaoliao Nov 9, 2024
1ea5633
Add line before uploading artifacts.
junhaoliao Nov 9, 2024
b395e12
Wrap strings with quotes.
junhaoliao Nov 9, 2024
5690e0d
Update demo link to use GitHub Pages.
junhaoliao Nov 9, 2024
b972057
Place comments before lines.
junhaoliao Nov 9, 2024
e546847
Add `id: "deployment"` into step.
junhaoliao Nov 9, 2024
e11f003
Reformat yaml.
junhaoliao Nov 9, 2024
88bf319
Fix yaml syntax.
junhaoliao Nov 9, 2024
3aea76c
Add `npm` caching.
junhaoliao Nov 9, 2024
6029019
Add name to the cache steps.
junhaoliao Nov 9, 2024
df4a275
test cache.
junhaoliao Nov 9, 2024
108ae1f
Use caching provided by actions/setup-node@v4.
junhaoliao Nov 9, 2024
1bb76c5
Change workflow name.
junhaoliao Nov 9, 2024
10c351c
Avoid spaces in braces - Apply suggestions from code review
junhaoliao Nov 9, 2024
5545ca2
Reformat - Apply suggestions from code review
junhaoliao Nov 9, 2024
6b31dcd
Capitalize first letter in comments - Apply suggestions from code review
junhaoliao Nov 9, 2024
a0ab914
Improve docs for `id-token: "write"` - Apply suggestions from code re…
junhaoliao Nov 9, 2024
dac2d1c
Rename deploy workflow file to use .yaml extension.
junhaoliao Nov 9, 2024
37911e7
Add `submodules: "recursive"` into "actions/checkout@v4".
junhaoliao Nov 9, 2024
ba82b3a
Enable job cancellation in deploy workflow.
junhaoliao Nov 9, 2024
5c46893
yaml: Add line before comment.
junhaoliao Nov 10, 2024
8bccb9a
Remove `actions: "write"` from GITHUB_TOKEN permission list.
junhaoliao Nov 10, 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
42 changes: 42 additions & 0 deletions .github/workflows/deploy-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: "deploy-github-pages"

on:
push:
branches: [ "main" ]
junhaoliao marked this conversation as resolved.
Show resolved Hide resolved

jobs:
build:
runs-on: "ubuntu-latest"

junhaoliao marked this conversation as resolved.
Show resolved Hide resolved
steps:
- uses: "actions/checkout@v4"
Copy link
Member Author

@junhaoliao junhaoliao Nov 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we add

        with:
          submodules: "recursive"

here or remove it in ?

yscope-log-viewer/.github/workflows/lint.yaml

Lines 26 to 27 in bc8109f

with:
submodules: "recursive"

Copy link
Member

@kirkrodrigues kirkrodrigues Nov 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would either add it here or leave both as is. Although we don't need it in lint.yaml currently, hopefully we'll add yscope-dev-utils to this repo soon in service of adding more automated linting. So in that case, changing lint.yaml would be unnecessary; I'm not sure whether we would need to change deploy-gh-pages.yml at that point.

Speaking of, I just noticed that we should rename this workflow file with .yaml.


- uses: "actions/setup-node@v4"
with:
node-version: "22"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Consider using a stable Node.js version.

Node.js 22 is currently in pre-release status. For production deployments, it's recommended to use the current LTS version (20.x).

Apply this diff:

- node-version: "22"
+ node-version: "20"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- uses: "actions/setup-node@v4"
with:
node-version: "22"
- uses: "actions/setup-node@v4"
with:
node-version: "20"

cache: "npm"
cache-dependency-path: "./package-lock.json"

- run: "npm install"
- run: "npm run build"
junhaoliao marked this conversation as resolved.
Show resolved Hide resolved

- name: "Upload static files as artifact"
uses: "actions/upload-pages-artifact@v3"
with:
path: "./dist"

deploy:
needs: "build"
permissions:
# to deploy to Pages
junhaoliao marked this conversation as resolved.
Show resolved Hide resolved
pages: "write"
# to verify the deployment originates from an app
junhaoliao marked this conversation as resolved.
Show resolved Hide resolved
id-token: "write"
runs-on: "ubuntu-latest"
environment:
name: "github-pages"
url: "${{steps.deployment.outputs.page_url}}"
steps:
- name: "Deploy to GitHub Pages"
id: "deployment"
uses: "actions/deploy-pages@v4"
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ See the docs in our [developer guide](docs/dev-guide).
[log4j1-appenders]: https://github.com/y-scope/log4j1-appenders
[logback-appenders]: https://github.com/y-scope/logback-appenders
[monaco-editor]: https://microsoft.github.io/monaco-editor/
[online-demo]: https://yscope.com/log-viewer?filePath=https://yscope.s3.us-east-2.amazonaws.com/sample-logs/yarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst
[online-demo]: https://y-scope.github.io/yscope-log-viewer/?filePath=https://yscope.s3.us-east-2.amazonaws.com/sample-logs/yarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst
[report-bug]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=bug&template=bug-report.yml
[request-feature]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=enhancement&template=feature-request.yml
[zulip]: https://yscope-clp.zulipchat.com/
Expand Down
Loading