Split components into seperate packages #411

wolfy1339 · 2021-03-21T20:31:58Z

As per our discussion in #362, I started refactoring the repository to move the 3 components of this repo (examples, schemas, types) into seperate packages.

All the build scripts work, all test scripts work except for the validate script

package.json

wolfy1339 · 2021-03-21T23:25:26Z

Everything now works for build & test scripts.

Now to figure out how to get semantic-release to publish the 4 packages at the same time

G-Rath

Looks good to me

G-Rath · 2021-04-01T19:33:13Z

bin/validate-payload-examples.ts

@@ -3,7 +3,7 @@
 import { DefinedError, ErrorObject } from "ajv";
 import path from "path";
 import { inspect } from "util";
-import { ajv, validate } from "../payload-schemas";
+import { ajv, validate } from "../payload-schemas/index";


Suggested change

import { ajv, validate } from "../payload-schemas/index";

import { ajv, validate } from "../payload-schemas";

nit: node imports index if it exists when you tell it to import a folder, meaning you can leave this file as is.

Yes, it usually does, but in this case, since there's a package.json in the directory with a main property, it'll use the main property which in this case is schema.json.

Which is why I used an explicit import instead of implicit

…kages

This reverts commit 64f5450.

Node (tested on v14) would use the file listed in the `main` field in `package.json` for the import, which is the `schema.json` file in this case, while we wanted the `index.ts` file

gr2m · 2021-04-01T21:48:35Z

Also it looks like the README has not yet been updated.

What should the 3 packages be? Can we put them in 3 different directories, and have a README.md file for the respective package so that it will show up on npmjs.com?

wolfy1339 · 2021-04-01T22:11:32Z

Also it looks like the README has not yet been updated.

I'll update the README

Can we put them in 3 different directories

They already are seperated, only the global package is

payload-types => @octokit/webhooks-types
payload-schemas => @octokit/webhooks-schema
payload-examples => @octokit/webhooks-examples
./ => @octokit/webhooks-definitions

and have a README.md file for the respective package so that it will show up on npmjs.com?

For sure, that can be done.

wolfy1339 · 2021-04-02T01:21:06Z

I have found this semantic-release plugin, https://github.com/pmowrer/semantic-release-monorepo
It does look like it could very well help us out

gr2m · 2021-04-02T17:44:36Z

I have found this semantic-release plugin, https://github.com/pmowrer/semantic-release-monorepo
It does look like it could very well help us out

I didn't use that plugin myself, but it sounds like it supports different versions for the different packages in the repository, which is not something we need in our case.

I think we could use semantic-release for the root (@octokit/webhooks-definitions), use semantic-release-plugin-update-version-in-files to replace the versions in the payload-*/package.json files, then run npm publish in the payload-* folders. That we we'd have a single version for all packages in this repository, with one matching github release and its release notes.

wolfy1339 · 2021-04-02T19:01:55Z

The changes are made.

~~Although there won't be a way to tell npm that this should be a beta, currently~~ EDIT: I found a way to set the beta tag whenever the branch is beta

gr2m

Looks good to me 👍

octokitbot · 2021-04-02T21:46:49Z

🎉 This PR is included in version 3.67.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

octokitbot · 2021-04-02T21:49:27Z

🎉 This PR is included in version 3.68.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

wolfy1339 · 2021-04-02T21:51:17Z

It appears as though, it's not publishing the other packages.

~~The steps get skipped over~~ EDIT: The steps now get fired properly.

wolfy1339 · 2021-04-02T22:09:29Z

There is 2 issues here currently:

The packages don't seem to want to be published to npm (possibly due to the fact that we are trying to use the @beta tag when @latest doesn't exist yet
semantic-release-plugin-update-version-in-files doesn't seem to be working, there is no mention of it in semantic-release logs

gr2m · 2021-04-02T22:11:59Z

I’ll have a look ASAP, tonight or tomorrow

wolfy1339 · 2021-04-02T23:57:20Z

I don't think this solution for publishing packages will work as is.
Currently it will publish a release on every single push to either the master or beta branch. What would be needed is logic similar to the one in @semantic-release/commit-analyzer to determine if we need to make a release

octokitbot · 2021-04-17T13:42:31Z

🎉 This PR is included in version 3.68.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

wolfy1339 added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Mar 21, 2021

wolfy1339 changed the title ~~🚧 Split components into seperate packages~~ 🚧 Split components into seperate packages Mar 21, 2021

wolfy1339 requested review from G-Rath, gr2m and oscard0m March 21, 2021 20:33

G-Rath reviewed Mar 21, 2021

View reviewed changes

package.json Outdated Show resolved Hide resolved

wolfy1339 linked an issue Mar 21, 2021 that may be closed by this pull request

Moving index.json to a different package #362

Closed

wolfy1339 changed the base branch from master to beta March 21, 2021 22:51

wolfy1339 changed the base branch from beta to master March 21, 2021 22:52

wolfy1339 force-pushed the split-multi-package branch 2 times, most recently from f8df726 to 6e55714 Compare March 29, 2021 20:49

wolfy1339 force-pushed the split-multi-package branch from 6e55714 to a9aaa06 Compare March 31, 2021 20:54

wolfy1339 requested a review from G-Rath March 31, 2021 20:55

G-Rath approved these changes Apr 1, 2021

View reviewed changes

wolfy1339 added 14 commits April 1, 2021 16:07

chore(pkg): move files around to accomodate publishing individual pac…

181b703

…kages

chore(pkg): add individual package.json for each component

eecdd98

chore(pkg): remove main and files properties

bfabdbe

chore: update lint scripts to accout for new file structure

0c69227

build(deps): add the 3 seperate component packages as dependencies

130017b

fix: update the index.json build script with the new path

a91775d

fix: update schema.json path in the octokit-types.ts

8afbe7f

Revert "chore(pkg): remove main and files properties"

ed72222

This reverts commit 64f5450.

ci(release): add an asset copy step

eedc782

build(pkg): remove dependencies to avoid breaking change

91c2452

chore(lint): run prettier

4564418

fix: add explicit import for index.ts

b5a20b3

Node (tested on v14) would use the file listed in the `main` field in `package.json` for the import, which is the `schema.json` file in this case, while we wanted the `index.ts` file

ci: fix filename for payload types

b89cf3a

pkg: add descriptions to each component

c83e174

wolfy1339 changed the base branch from master to beta April 1, 2021 21:48

wolfy1339 added 5 commits April 1, 2021 18:32

docs: update README to point to the split packages

7370a17

docs: add READMEs for the split packages

98654bb

chore(lint): Add the README files to the files to be linted

cbf1a91

lint: fix linting errors in READMEs

11dfbe7

docs: update README of payload-types

d7ff69a

wolfy1339 force-pushed the split-multi-package branch from 98e1ee2 to d7ff69a Compare April 1, 2021 23:09

wolfy1339 added 3 commits April 2, 2021 14:48

ci: add semantic-release plugin to change version in packages

e20ce1f

ci(release): update semantic-release config to use globs

e03cfef

ci(release): use the directory argument of npm publish

78a2f5e

wolfy1339 added 3 commits April 2, 2021 15:07

ci(release): set beta tag when branch is beta

165d0db

docs: update CONTRIBUTING.md with new paths

338d96e

docs(bin): link to new packages

92c801c

gr2m approved these changes Apr 2, 2021

View reviewed changes

wolfy1339 merged commit 92cca6a into beta Apr 2, 2021

wolfy1339 deleted the split-multi-package branch April 2, 2021 21:46

octokitbot added the released on @beta label Apr 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split components into seperate packages #411

Split components into seperate packages #411

wolfy1339 commented Mar 21, 2021

wolfy1339 commented Mar 21, 2021

G-Rath left a comment

G-Rath Apr 1, 2021

wolfy1339 Apr 1, 2021

gr2m commented Apr 1, 2021

wolfy1339 commented Apr 1, 2021

wolfy1339 commented Apr 2, 2021

gr2m commented Apr 2, 2021

wolfy1339 commented Apr 2, 2021 •

edited

Loading

gr2m left a comment

octokitbot commented Apr 2, 2021

octokitbot commented Apr 2, 2021

wolfy1339 commented Apr 2, 2021 •

edited

Loading

wolfy1339 commented Apr 2, 2021

gr2m commented Apr 2, 2021

wolfy1339 commented Apr 2, 2021

octokitbot commented Apr 17, 2021

	import { ajv, validate } from "../payload-schemas/index";
	import { ajv, validate } from "../payload-schemas";

Split components into seperate packages #411

Split components into seperate packages #411

Conversation

wolfy1339 commented Mar 21, 2021

wolfy1339 commented Mar 21, 2021

G-Rath left a comment

Choose a reason for hiding this comment

G-Rath Apr 1, 2021

Choose a reason for hiding this comment

wolfy1339 Apr 1, 2021

Choose a reason for hiding this comment

gr2m commented Apr 1, 2021

wolfy1339 commented Apr 1, 2021

wolfy1339 commented Apr 2, 2021

gr2m commented Apr 2, 2021

wolfy1339 commented Apr 2, 2021 • edited Loading

gr2m left a comment

Choose a reason for hiding this comment

octokitbot commented Apr 2, 2021

octokitbot commented Apr 2, 2021

wolfy1339 commented Apr 2, 2021 • edited Loading

wolfy1339 commented Apr 2, 2021

gr2m commented Apr 2, 2021

wolfy1339 commented Apr 2, 2021

octokitbot commented Apr 17, 2021

wolfy1339 commented Apr 2, 2021 •

edited

Loading

wolfy1339 commented Apr 2, 2021 •

edited

Loading