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

feat!: publish as esm-only #80

Merged
merged 2 commits into from Oct 19, 2022
Merged

feat!: publish as esm-only #80

merged 2 commits into from Oct 19, 2022

Conversation

achingbrain
Copy link
Member

@achingbrain achingbrain commented Oct 15, 2022

Following on from the conversation in ipld/ipld#224 this converts this repo to use the latest aegir with Unified CI.

  1. Remove all build related dev deps apart from aegir
  2. Run the npx aegir check-project command to update project config
  3. Remove non-Unified-CI github actions
  4. Rename test/*.js to test/*.spec.js so aegir can find them
  5. Update tsconfig.json to extend config from aegir
  6. Remove "main" and other unused fields from package.json
  7. Use chai from aegir pre-configured with plugins we use
  8. Fixes everything the linter complains about

This will need a follow up PR to protocol/.github to add this repo to the Unified CI config file so it'll get automated config updates in the future.

Apologies that this PR is so noisy, most of it is from the check-project command

Following on from the conversation in ipld/ipld#224 this converts this repo to use the latest aegir with Unified CI.

1. Remove all build related dev deps apart from `aegir`
1. Run the `npx aegir check-project` command to update project config
1. Remove non-Unified-CI github actions
1. Update imports to import from `src/index.js` instead of `@ipld/dag-pb`
1. Rename `test/*.js` to `test/*.spec.js` so aegir can find them
1. Update `tsconfig.json` to extend config from `aegir`
1. Remove `"main"` and other unused fields from `package.json`
1. Use `chai` from `aegir` pre-configured with plugins we use
1. Fixes everything the linter complains about

This will need a follow up PR to `protocol/.github` to add this repo to the Unified CI [config file](https://github.com/protocol/.github/blob/master/configs/js.json) so it'll get automated config updates in the
future.

Apologies that this PR is so noisy, most of it is from the `check-project` command
},
"keywords": [
"ipfs",
"ipld",
"multiformats"
],
"author": "Rod <rod@vagg.org> (http://r.va.gg/)",
"license": "(Apache-2.0 AND MIT)",
"engines": {
Copy link
Member

Choose a reason for hiding this comment

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

these don't happen to be kept updated by unified-ci do they? it concerns me that we're introducing more fields that need manual attention to keep current

Copy link
Member Author

Choose a reason for hiding this comment

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

I had a similar concern - they are defined here and kept up to date by the aegir check-project command.

Long(ish) term I was hoping for a aegir check-project -y type thing we could run as part of unified CI to automate PRs for that too, I wanted to get a view on how much custom config we have across the estate first though - turns out not much so that sounds doable at some point. I think the biggest thing is the divergence in readme styles but I'm sure there's a middle ground somewhere.

@achingbrain achingbrain merged commit 131ea8e into master Oct 19, 2022
@achingbrain achingbrain deleted the feat/publish-as-esm-only branch October 19, 2022 09:33
github-actions bot pushed a commit that referenced this pull request Oct 19, 2022
## [9.0.0](v8.0.11...v9.0.0) (2022-10-19)

### ⚠ BREAKING CHANGES

* publish as esm-only (#80)

### Features

* publish as esm-only ([#80](#80)) ([131ea8e](131ea8e))

### Trivial Changes

* **no-release:** bump actions/setup-node from 3.4.1 to 3.5.0 ([#76](#76)) ([30578b4](30578b4))
* **no-release:** bump actions/setup-node from 3.5.0 to 3.5.1 ([#79](#79)) ([a59b710](a59b710))
* **no-release:** bump ipld-garbage from 4.0.10 to 5.0.0 ([#72](#72)) ([6e428e1](6e428e1))
* update project config ([cf08c02](cf08c02))
@github-actions
Copy link

🎉 This PR is included in version 9.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants