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

Updated Package Setup #440

Merged
merged 1 commit into from Mar 8, 2024
Merged

Conversation

himerus
Copy link
Contributor

@himerus himerus commented Mar 8, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a custom component outline-core-link for displaying a link to the Outline GitHub repository.
    • Added MIT License to the outline-core-alert component, allowing for use, modification, distribution, and sale under specified conditions.
  • Chores

    • Updated GitHub actions for better deployment and status checking of GitHub Pages.
  • Documentation

    • Added licensing information for the outline-core-alert component.
  • Refactor

    • Enhanced CSS handling in Vite projects with new PostCSS plugins configuration and the ability to import CSS files as strings.

Copy link

changeset-bot bot commented Mar 8, 2024

⚠️ No Changeset found

Latest commit: 994355c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Mar 8, 2024

Walkthrough

The project has undergone updates to improve its infrastructure and functionality. GitHub Actions versions have been updated for better operational efficiency in deployment and status checking. A new MIT License has been introduced for the outline-core-alert component, ensuring open use and distribution with necessary legal protections. Additionally, enhancements in web component development are evident with the introduction of a basic HTML page showcasing a custom component and updates to Vite configuration for better CSS handling and modular build setup.

Changes

File(s) Change Summary
.github/workflows/build.yml Updated GitHub Actions crazy-max/ghaction-github-status and crazy-max/ghaction-github-pages from v3 to v4.
packages/components/outline-core-alert/LICENSE.md Introduced the MIT License.
packages/components/outline-core-alert/index.html Added a basic HTML page with a custom component outline-core-link.
packages/components/outline-core-alert/src/component.d.ts Enabled importing CSS files as strings with the ?inline query in Vite.
packages/components/outline-core-alert/vite.config.js Configured PostCSS plugins and build settings for ES module format library generation.

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

netlify bot commented Mar 8, 2024

Deploy Preview for outlinejs ready!

Name Link
🔨 Latest commit 994355c
🔍 Latest deploy log https://app.netlify.com/sites/outlinejs/deploys/65eb6abdffb7660008106191
😎 Deploy Preview https://deploy-preview-440--outlinejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/espree@7.3.1 None +2 1.31 MB eslintbot
npm/esprima@4.0.1 None 0 314 kB ariya
npm/estraverse@5.3.0 None 0 37.1 kB michaelficarra
npm/etag@1.8.1 filesystem 0 10.8 kB dougwilson
npm/execa@5.1.1 environment, shell Transitive: filesystem +2 90.9 kB sindresorhus
npm/extend-shallow@3.0.2 None +2 21.4 kB phated
npm/fast-deep-equal@3.1.3 None 0 13 kB esp
npm/fast-glob@3.3.2 filesystem +5 211 kB mrmlnc
npm/fast-json-stable-stringify@2.1.0 None 0 17 kB esp
npm/fresh@0.5.2 None 0 10.1 kB dougwilson
npm/fs-extra@7.0.1 filesystem Transitive: environment +1 157 kB ryanzim
npm/function.prototype.name@1.1.6 Transitive: eval +21 2.39 MB ljharb
npm/gaze@1.1.3 filesystem +3 131 kB shama
npm/get-caller-file@2.0.5 None 0 4.72 kB stefanpenner
npm/get-intrinsic@1.2.4 eval +5 124 kB ljharb
npm/get-value@2.0.6 None 0 3.71 kB jonschlinkert
npm/glob-parent@5.1.2 None 0 12.1 kB phated
npm/glob@10.3.10 Transitive: environment, filesystem, shell +5 1.06 MB isaacs
npm/globby@11.1.0 filesystem +8 242 kB sindresorhus
npm/graceful-fs@4.2.11 environment, filesystem 0 32.5 kB isaacs
npm/has-bigints@1.0.2 None 0 12.8 kB ljharb
npm/has-property-descriptors@1.0.2 Transitive: eval +7 147 kB ljharb
npm/has-symbols@1.0.3 None 0 20.6 kB ljharb
npm/has-tostringtag@1.0.2 None +1 38.2 kB ljharb
npm/highlight.js@10.7.3 None 0 1.71 MB highlightjs_bot

🚮 Removed packages: npm/@phase2/outline-adopted-stylesheets-controller@1.0.2, npm/caniuse-lite@1.0.30001591, npm/lit@3.1.2, npm/postcss-discard-comments@6.0.1, npm/postcss-nested-import@1.3.0, npm/postcss-nested@6.0.1, npm/postcss-preset-env@9.4.0, npm/postcss-selector-parser@6.0.15, npm/postcss@8.4.35, npm/tslib@2.6.2, npm/vite@5.1.4

View full report↗︎

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 759963f and 994355c.
Files ignored due to path filters (3)
  • packages/components/outline-core-alert/package.json is excluded by: !**/*.json
  • packages/components/outline-core-link/package.json is excluded by: !**/*.json
  • packages/controllers/adopted-stylesheets/package.json is excluded by: !**/*.json
Files selected for processing (5)
  • .github/workflows/build.yml (1 hunks)
  • packages/components/outline-core-alert/LICENSE.md (1 hunks)
  • packages/components/outline-core-alert/index.html (1 hunks)
  • packages/components/outline-core-alert/src/component.d.ts (1 hunks)
  • packages/components/outline-core-alert/vite.config.js (1 hunks)
Additional comments: 4
packages/components/outline-core-alert/index.html (1)
  • 1-24: - The HTML structure is well-formed and follows best practices for a basic HTML document.
  • The use of the lang attribute on the <html> tag is good for accessibility.
  • The meta tags for charset and viewport are correctly implemented.
  • The favicon link includes integrity and crossorigin attributes, enhancing security and cross-origin resource sharing.
  • The script tag correctly specifies the type as module, which is necessary for ES module support.
  • The outline-core-link component is used to showcase a link to the Outline GitHub repository, demonstrating a practical example of the component's usage.

Overall, the HTML page is well-structured and serves as a good example of the outline-core-link component. It adheres to modern HTML standards and best practices.

packages/components/outline-core-alert/src/component.d.ts (1)
  • 1-22: - The TypeScript declaration file is well-documented, with clear comments explaining the purpose and usage of the declaration.
  • The use of the ?inline query parameter for importing CSS files as strings is correctly declared, aligning with Vite's capabilities for handling CSS imports.
  • The comments include links to relevant documentation, which is helpful for developers who may be unfamiliar with these features.

This declaration file is a valuable addition to the project, enhancing developer experience by providing type checking and autocompletion for a specific Vite feature. It follows best practices for TypeScript and is well-documented.

packages/components/outline-core-alert/vite.config.js (1)
  • 1-49: - The Vite configuration is well-structured and clearly defines the project's CSS processing and build settings.
  • The use of PostCSS plugins (postcss-preset-env, postcss-nested, postcss-nested-import, postcss-discard-comments) is correctly configured, enhancing the project's CSS capabilities.
  • The build settings are appropriately configured for generating a library in ES module format, specifying the entry file, output file name, and external dependencies.

This configuration file effectively sets up the project's build process, optimizing CSS processing and specifying the build output. It follows best practices for Vite configuration and is well-documented.

.github/workflows/build.yml (1)
  • 158-168: - The updates to the GitHub Actions versions (crazy-max/ghaction-github-status and crazy-max/ghaction-github-pages from v3 to v4) are correctly implemented.
  • The adjustments to thresholds for the GitHub Pages status check (overall_threshold: minor, pages_threshold: partial_outage) are appropriate and align with the objectives of optimizing the project's continuous integration and deployment workflows.
  • The deployment job's configuration for GitHub Pages (target_branch: gh-pages, build_dir: storybook-static, etc.) is correctly set up, ensuring that the deployment process utilizes the latest features and improvements offered by the updated actions.

These changes modernize the project's GitHub workflows, improving the efficiency and reliability of the continuous integration and deployment processes. The updates are well-documented and follow best practices for GitHub Actions configuration.

@himerus himerus merged commit 01ae563 into next Mar 8, 2024
10 checks passed
@himerus himerus deleted the feature/dependency-detangler-part-deux branch March 8, 2024 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant