Skip to content

Commit

Permalink
build: move from electron-rebuild to @electron/rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
MarshallOfSound committed Oct 27, 2022
1 parent 6f94aaa commit d67ab4e
Show file tree
Hide file tree
Showing 6 changed files with 908 additions and 3,946 deletions.
7 changes: 5 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ jobs:
- checkout
- *step-restore-cache
- run: yarn install --frozen-lockfile
- run: npx semantic-release
- run: npx @continuous-auth/[email protected]
- run: npx [email protected]

workflows:
version: 2
test_and_release:
Expand All @@ -95,4 +97,5 @@ workflows:
filters:
branches:
only:
- master
- main
context: cfa-release
3 changes: 2 additions & 1 deletion .releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"@semantic-release/release-notes-generator",
"@continuous-auth/semantic-release-npm",
"@semantic-release/github"
]
],
"branches": [ "main" ]
}
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Electron Rebuild

[![CircleCI](https://circleci.com/gh/electron/electron-rebuild.svg?style=svg)](https://circleci.com/gh/electron/electron-rebuild)
[![NPM](https://img.shields.io/npm/v/electron-rebuild.svg?style=flat)](https://npm.im/electron-rebuild)
[![Coverage Status](https://codecov.io/gh/electron/electron-rebuild/branch/master/graph/badge.svg)](https://codecov.io/gh/electron/electron-rebuild)
[![CircleCI](https://circleci.com/gh/electron/rebuild.svg?style=svg)](https://circleci.com/gh/electron/rebuild)
[![NPM](https://img.shields.io/npm/v/@electron/rebuild.svg?style=flat)](https://npm.im/@electron/rebuild)
[![Coverage Status](https://codecov.io/gh/electron/rebuild/branch/main/graph/badge.svg)](https://codecov.io/gh/electron/rebuild)

This executable rebuilds native Node.js modules against the version of Node.js
that your Electron project is using. This allows you to use native Node.js
Expand All @@ -14,7 +14,7 @@ modules in Electron apps without your system version of Node.js matching exactly
Install the package with `--save-dev`:

```sh
npm install --save-dev electron-rebuild
npm install --save-dev @electron/rebuild
```

Then, whenever you install a new npm package, rerun electron-rebuild:
Expand Down Expand Up @@ -83,7 +83,7 @@ Options:
Copyright 2016
```

### How can I use this with [Electron Forge](https://github.com/electron-userland/electron-forge)?
### How can I use this with [Electron Forge](https://github.com/electron/forge)?

This package is automatically used with Electron Forge when packaging an Electron app.

Expand All @@ -94,7 +94,7 @@ for Electron Packager. For example:

```javascript
import packager from 'electron-packager';
import rebuild from 'electron-rebuild';
import rebuild from '@electron/rebuild';

packager({
// … other options
Expand All @@ -120,7 +120,7 @@ electron-rebuild is also a library that you can require into your app or
build process. It has a very simple API:

```javascript
import rebuild from 'electron-rebuild';
import rebuild from '@electron/rebuild';

// Public: Rebuilds a node_modules directory with the given Electron version.
//
Expand Down Expand Up @@ -156,7 +156,3 @@ const pathToElectron = require('electron');
console.error(e);
});
```

### Alternatives

- [require-rebuild](https://github.com/juliangruber/require-rebuild) patches `require()` to rebuild native node modules on the fly
10 changes: 5 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Contributing to electron-rebuild
# Contributing to @electron/rebuild

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable
behavior to [email protected].

The following is a set of guidelines for contributing to electron-rebuild.
The following is a set of guidelines for contributing to @electron/rebuild.
These are just guidelines, not rules, use your best judgment and feel free to
propose changes to this document in a pull request.

## Submitting Issues

* You can create an issue [here](https://github.com/electron/electron-rebuild/issues/new),
* You can create an issue [here](https://github.com/electron/rebuild/issues/new),
but before doing that please read the notes below and include as many details as
possible with your report. If you can, please include:
* The version of electron and electron-rebuild you are using
* The version of electron and @electron/rebuild you are using
* The operating system you are using
* If applicable, what you were doing when the issue arose and what you
expected to happen
* Other things that will help resolve your issue:
* Screenshots and animated GIFs
* Error output that appears in your terminal, dev tools or as an alert
* Perform a [cursory search](https://github.com/electron/electron-rebuild/issues?utf8=✓&q=is%3Aissue+)
* Perform a [cursory search](https://github.com/electron/rebuild/issues?utf8=✓&q=is%3Aissue+)
to see if a similar issue has already been submitted

## Submitting Pull Requests
Expand Down
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "electron-rebuild",
"name": "@electron/rebuild",
"version": "0.0.0-development",
"description": "Electron supporting package to rebuild native node modules against the currently installed electron",
"main": "lib/src/main.js",
Expand All @@ -23,17 +23,17 @@
],
"repository": {
"type": "git",
"url": "https://github.com/electron/electron-rebuild"
"url": "https://github.com/electron/rebuild"
},
"keywords": [
"electron"
],
"author": "Paul Betts <[email protected]>",
"license": "MIT",
"bugs": {
"url": "https://github.com/electron/electron-rebuild/issues"
"url": "https://github.com/electron/rebuild/issues"
},
"homepage": "https://github.com/electron/electron-rebuild",
"homepage": "https://github.com/electron/rebuild",
"engines": {
"node": ">=12.13.0"
},
Expand All @@ -54,7 +54,7 @@
"yargs": "^17.0.1"
},
"devDependencies": {
"@continuous-auth/semantic-release-npm": "^2.0.0",
"@continuous-auth/semantic-release-npm": "^3.0.0",
"@istanbuljs/nyc-config-typescript": "^1.0.1",
"@types/chai": "^4.2.12",
"@types/chai-as-promised": "^7.1.3",
Expand All @@ -78,7 +78,6 @@
"eslint-plugin-mocha": "^9.0.0",
"mocha": "^9.0.1",
"nyc": "^15.1.0",
"semantic-release": "^17.1.1",
"ts-node": "^10.0.0",
"typescript": "^4.0.2"
},
Expand Down
Loading

0 comments on commit d67ab4e

Please sign in to comment.