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

Upgrade and fix builds #93

Merged
merged 23 commits into from
Jul 26, 2023
Merged

Upgrade and fix builds #93

merged 23 commits into from
Jul 26, 2023

Conversation

Taeir
Copy link
Contributor

@Taeir Taeir commented Jul 24, 2023

  • Fix and upgrade eleventy
  • Remove compiled docs files which were duplicated in the repo
  • Switch from copying files (my poor SSD!) to using eleventy's passthrough (no copying required)
  • Add npm run dev command to start a dev server. It will automatically reload your page in the browser with the changes when you make any change to SCSS, TypeScript or Docs sources for really smooth and speedy development.
  • Change build commands
    • npm run css_build/js_build/docs_build will build the respective component only.
    • npm run build will now build all.
  • Update README and documentation for installation to match with the updated setup.
  • Switch from npm package blacklist to a whitelist in the package.json to make sure we don't accidentally include unnecessary files (like we were doing for a while already).
  • Add CI for pull requests to develop (check whether build keeps working)
  • Change GitHub pages setup to build first and then deploy that rather than requiring compiled files in the repo
  • Remove many compiled files from the repo
    • /dist is generated from SCSS in /src
    • /js is generated from TypeScript in /js_src
    • /docs is generated from Markdown / HTML templates in /docs_src

After merging this, a small configuration setting on the repo may be necessary to set GitLab pages to work from GitHub actions.

Fixes #82
Fixes #86

Also update the readme and the commands.

Fix javascript not getting compiled by the build action.
@Oaphi Oaphi added the area: documentation Improvements or additions to documentation label Jul 24, 2023
@Taeir Taeir changed the title Upgrade and fix eleventy Upgrade and fix builds Jul 24, 2023
@Taeir Taeir marked this pull request as ready for review July 25, 2023 09:40
@Taeir Taeir requested review from Oaphi, a team and ArtOfCode- July 25, 2023 09:43
@Taeir Taeir mentioned this pull request Jul 25, 2023
Copy link
Member

@Oaphi Oaphi left a comment

Choose a reason for hiding this comment

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

LGTM! ♥ Nothing else to add — this is a major improvement all around.

@ArtOfCode- ArtOfCode- merged commit 4ce87bd into develop Jul 26, 2023
@ArtOfCode- ArtOfCode- deleted the fix-eleventy branch July 26, 2023 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Trying to build docs gives Eleventy error Build instructions differ between readme and guide
3 participants