Skip to content

Commit

Permalink
Merge pull request #4 from lottie/revert-3-mf/release-v1
Browse files Browse the repository at this point in the history
Revert "v1.0.0 release"
  • Loading branch information
Aidosmf authored May 24, 2024
2 parents 1749df4 + d545542 commit f1bc2a0
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 34 deletions.
5 changes: 0 additions & 5 deletions .changeset/poor-geckos-punch.md

This file was deleted.

6 changes: 1 addition & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
env:
NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Create Release Pull Request or Publish to GitHub registry
- name: Create Release Pull Request or Publish to github
id: changesets
uses: changesets/action@v1
with:
Expand All @@ -54,7 +54,3 @@ jobs:
NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish to NPM
if: steps.changesets.outputs.hasChangesets == 'false'
run: npm publish --@lottie-animation-community:registry=https://registry.npmjs.org
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# lottie-types

## Installation

```bash
npm install --save @lottie-animation-community/lottie-types
```

## Summary

This package contains type definitions for Lottie animation format

## Details
This repository contains type definitions for the Lottie animation format.

The project has been migrated from the [lottiefiles](https://github.com/lottiefiles) organization that has been used internally. The definition types have been built based on [lottie-docs/schema](https://lottiefiles.github.io/lottie-docs/schema/) with a few differences: firstly, some
additional informative type comments have been added through testing the schema types with real Lottie data; secondly,
Expand All @@ -25,10 +15,10 @@ such as complicated conditionals, prefixItems, and some def reference scenarios.

The schema definitions have been synced with [marcusstenbeck/lottie-types](https://github.com/marcusstenbeck/lottie-types) as well.

## Plan
## Todo

- auto-generate types from [lottie-docs/schema](https://lottiefiles.github.io/lottie-docs/schema/)
- publish the final definition bundle to [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)
- [] auto-generate types from [lottie-docs/schema](https://lottiefiles.github.io/lottie-docs/schema/)
- [] publish the final definition bundle to [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)

## Contribution

Expand All @@ -48,7 +38,9 @@ The following steps will get you setup to contribute changes to this repo:
6. After merging to `main` the Github action will create another PR for only version bumping and changelog, which you
have to merge the PR manually

7. the package will be released to the NPM and GitHub registry after the merging the Changeset PR
7. the package will be released after the merging

8. Create a git tag locally and run `git push --follow-tags` to make it available in the origin

## Commands

Expand All @@ -65,4 +57,4 @@ The following steps will get you setup to contribute changes to this repo:

## License

[MIT](./LICENSE) © [lottie-animation-community](https://github.com/lottie)
[MIT](./LICENSE) © [lottie-animation-community](https://github.com/lottie-animation-community)
15 changes: 7 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@lottie-animation-community/lottie-types",
"version": "0.0.0",
"description": "TypeScript definitions for Lottie animation format",
"description": "Type definitions for the Lottie animation format",
"main": "index.js",
"types": "index.d.ts",
"files": [
Expand All @@ -18,15 +18,13 @@
"changelog:version": "changeset version",
"changelog:publish": "changeset publish"
},
"repository": {
"type": "git",
"url": "git+https://github.com/lottie/lottie-types.git"
},
"repository": "https://github.com/lottie-animation-community/lottie-types",
"keywords": [
"lottie",
"lottie-animation-community",
"lottiefiles",
"lottie-schema",
"lottie-types"
"lottie-types",
"lottie-file-format"
],
"author": "Aidos Sabit <https://github.com/aidosmf/>",
"license": "MIT",
Expand All @@ -44,6 +42,7 @@
"**/*": "prettier --write --ignore-unknown"
},
"publishConfig": {
"access": "public"
"registry": "https://npm.pkg.github.com/@lottie-animation-community",
"access": "restricted"
}
}

0 comments on commit f1bc2a0

Please sign in to comment.