Skip to content

Latest commit

 

History

History
142 lines (78 loc) · 6.47 KB

CHANGELOG.md

File metadata and controls

142 lines (78 loc) · 6.47 KB

@reuters-graphics/graphics-kit

1.0.6

Patch Changes

  • 355aa61: Improves S3 upload speed and cache strategy.

    Projects already created can get the same boost by updating @reuters-graphics/graphics-bin in package.json's devDependencies to at least ^1.1.2.

1.0.5

Patch Changes

  • 531affc: Bumps graphics-bin and graphics-kit-publisher for our new IHN-approved AWS S3 preview bucket.

    Following the planned change to our CloudFront distribution on Dec. 17, projects without this change will not be able to publish preview pages.

    Migration steps

    If your project was created before the release of the 1.0.0 version of the Graphics Kit, (check the version number in your project's package.json) you must create a new project and migrate your app to that.

    When creating a new project, you should create a new repo, but you may skip creating a RNGS.io doc if you have an existing one or are using Google Docs for content.

    Copy any components or stylesheets you made or changed from the src/lib/ directory into the new project, as well as any static files (images, etc.) in src/statics/ and AI files in project-files/.

    If you didn't create a new RNGS.io doc above, copy the configuration file rngs-io.json or google.json to your new project.

    You may need to also update some components in the pages/ directory if you changed any code there.

    If your project was created after the 1.0.0 version, then you can bump the version numbers of the dependencies @reuters-graphics/graphics-bin and @reuters-graphics/graphics-kit-publisher to the latest version in package.json and reinstall with pnpm i.

1.0.4

Patch Changes

  • cdec626: Bumps rngs-io-client to gracefully handle not creating a RNGS.io story on project startup. See #134.

1.0.3

Patch Changes

  • 23c0f4e: Adds LogBlock component for printing warnings and info messages on a page in development.

    <script>
  import LogBlock from '$lib/components/dev/LogBlock.svelte';
</script>

<LogBlock message="A red warning message to the user" />

<LogBlock level="info" message="A softer info message" />

    ... and adds info LogBlocks for ad spots in development.

1.0.2

Patch Changes

  • 672c5fa: Adds live endpoints handler class. Updates minimum Node version to 20.

1.0.1

Patch Changes

  • a1f847a: Updates sass API to use the modern compiler.

1.0.0

Major Changes

  • 474403f: The 1.0 🎉 release of the Reuters Graphics Kit.

    Migration steps

    Upgrade to Node version 20 or 22 and install pnpm globally:

    npm install -g pnpm

    All other updates will be included on new projects when started.

    You should not update existing projects or their dependencies as part of this release.

    New features

    RNGS.io becomes the default CMS

    New projects will, by default, create a new storyboard in RNGS.io and connect a new story to the project.

    You can, however, opt out of this option on project startup.

    If using Google Docs, you'll need to create a new doc yourself (by copying from this template in Drive) and add it to your project's google.json.

    Read more on configure Google Docs here.

    pnpm replaces yarn

    With this release, we're switching to pnpm and away from yarn for package management. There are a number of technical reasons why, but the main ones are because it's faster, takes up less memory, is better maintained and, generally, is an easy drop in replacement.

    In most cases, which package manager you use doesn't matter, but in a few it does, and with this change, we're covering more of those edge cases that occasionally come up.

    Obviously, the muscle memory around using yarn will take a bit to work out.

    For any of our basic commands, you can just replace yarn with pnpm:

    • pnpm start
    • pnpm preview
    • pnpn upload
    • pnpm pub

    🚨 IMPORTANT: Before you start your next project, you should install pnpm globally. Just run:

    npm install -g pnpm

    Preview pages will be deleted

    ... automatically when you publish your project via the terminal (pnpm pub). This is a safeguard after a few of our preview pages were accidentally leaked to the wider web.

    If you need to look at a preview page again after publishing, you just need to run pnpm preview to regenerate it.

    Updates from dependencies

    @reuters-graphics/graphics-components: Updated docs site

    With this update, we've gone through and touched up the components docs site. There are some minor changes on individual components, which have been documented. You will also notice "Quickit" stories have been transformed into "ArchieML" stories, for wider compatibility with RNGS.io.

    We've also generally scrubbed the docs for examples that had fallen behind component updates, but let us know if we missed any.

    Finally, we've given the "Guides" section a write-through. In particular, we've beefed up a new page on working with ArchieML docs. The goal is to get everyone more comfortable with the ArchieML > JSON > Svelte component flow. Check it out.

    @reuters-graphics/graphics-bin: Keys for publishing preview pages

    Starting next year, we're going to be rotating the keys that allow us to publish preview pages to our S3 bucket, i.e., the "testfiles" directory.

    To make it easier to maintain access without needing everyone to update a local file on your computer each time those keys change, we're going to leverage the API in our Reuters Graphics 1Password account.

    The first time you run pnpm preview in the updated kit, you'll be prompted to grab a 1Password API token from ... 1Password. This will be a one-time thing unless we decide to rotate that token after staff turnover, in which case you'll just be prompted again.