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

ISOM-1111: add publishing scripts #421

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Conversation

harishv7
Copy link
Contributor

@harishv7 harishv7 commented Aug 3, 2024

TL;DR

Add a new script (publisher.sh) and supporting TypeScript code to clone the isomer repo, fetch site data, and build schemas.

What changed?

  • Added publisher.sh to handle the publishing workflow, including cloning the repository, building the components, fetching from the database, and generating the site.
  • Script includes a step to run preBuild and build scripts from remote.
  • Created supporting TypeScript files to fetch and write site data (navbar, footer, config) and process resources from the database.
  • Added .env.template for environment variables.
  • Added package.json and package-lock.json for dependencies.
  • Configured tsconfig.json for TypeScript settings.

How to test?

  1. Set up the required environment variables in .env based on .env.template.
  2. Run publisher.sh and verify that it correctly clones the repository, fetches data, and generates the site.
  3. Check the output directories for schema and data files to confirm they have been created correctly.
  4. Validate the logging output to ensure all steps succeeded without errors.

Why make this change?

This script and supporting code streamline the process of building and publishing the site by automating the steps involved, thereby reducing the potential for human error and making the process more efficient.

Closes ISOM-1111 and ISOM-1245

Copy link

vercel bot commented Aug 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
isomer-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 28, 2024 8:48am

Copy link
Contributor Author

harishv7 commented Aug 3, 2024

Copy link

linear bot commented Aug 4, 2024

@harishv7 harishv7 marked this pull request as ready for review August 4, 2024 17:14
@harishv7 harishv7 requested a review from a team as a code owner August 4, 2024 17:14
@harishv7 harishv7 requested a review from seaerchin August 14, 2024 08:23
tooling/build/scripts/publishing/index.ts Outdated Show resolved Hide resolved
tooling/build/scripts/publishing/index.ts Outdated Show resolved Hide resolved
tooling/build/scripts/publishing/queries.ts Outdated Show resolved Hide resolved
tooling/build/scripts/publisher.sh Outdated Show resolved Hide resolved
tooling/build/scripts/publishing/index.ts Show resolved Hide resolved
@harishv7 harishv7 force-pushed the 08-03-add_publishing_scripts branch from 1fec7bb to 5a57296 Compare August 20, 2024 13:16
@harishv7 harishv7 requested a review from dcshzj August 20, 2024 15:42
@mergify mergify bot mentioned this pull request Aug 20, 2024
@harishv7 harishv7 force-pushed the 08-03-add_publishing_scripts branch from 2fd7df0 to 9f63fa8 Compare August 25, 2024 13:43
@harishv7 harishv7 force-pushed the 08-03-add_publishing_scripts branch from 5621a60 to daa2d99 Compare August 28, 2024 08:44
@harishv7 harishv7 merged commit a57cd98 into main Aug 28, 2024
17 checks passed
@harishv7 harishv7 deleted the 08-03-add_publishing_scripts branch August 28, 2024 08:52
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.

2 participants